From b528060a6e55c19e7f999ff27a3d5039889664c7 Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Fri, 5 Jun 2020 15:32:34 -0700 Subject: [PATCH] feat(displayvideo): update the API #### displayvideo:v1 The following keys were added: - resources.advertisers.resources.channels.methods.patch.description - resources.advertisers.resources.channels.methods.patch.flatPath - resources.advertisers.resources.channels.methods.patch.httpMethod - resources.advertisers.resources.channels.methods.patch.id - resources.advertisers.resources.channels.methods.patch.parameterOrder - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.channels.methods.patch.parameters.channelId.description - resources.advertisers.resources.channels.methods.patch.parameters.channelId.format - resources.advertisers.resources.channels.methods.patch.parameters.channelId.location - resources.advertisers.resources.channels.methods.patch.parameters.channelId.required - resources.advertisers.resources.channels.methods.patch.parameters.channelId.type - resources.advertisers.resources.channels.methods.patch.parameters.partnerId.description - resources.advertisers.resources.channels.methods.patch.parameters.partnerId.format - resources.advertisers.resources.channels.methods.patch.parameters.partnerId.location - resources.advertisers.resources.channels.methods.patch.parameters.partnerId.type - resources.advertisers.resources.channels.methods.patch.parameters.updateMask.description - resources.advertisers.resources.channels.methods.patch.parameters.updateMask.format - resources.advertisers.resources.channels.methods.patch.parameters.updateMask.location - resources.advertisers.resources.channels.methods.patch.parameters.updateMask.type - resources.advertisers.resources.channels.methods.patch.path - resources.advertisers.resources.channels.methods.patch.request.$ref - resources.advertisers.resources.channels.methods.patch.response.$ref - resources.advertisers.resources.channels.methods.patch.scopes - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.description - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.flatPath - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.id - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.path - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.request.$ref - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.scopes - resources.advertisers.resources.channels.resources.sites.methods.create.description - resources.advertisers.resources.channels.resources.sites.methods.create.flatPath - resources.advertisers.resources.channels.resources.sites.methods.create.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.create.id - resources.advertisers.resources.channels.resources.sites.methods.create.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.partnerId.description - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.partnerId.format - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.partnerId.location - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.partnerId.type - resources.advertisers.resources.channels.resources.sites.methods.create.path - resources.advertisers.resources.channels.resources.sites.methods.create.request.$ref - resources.advertisers.resources.channels.resources.sites.methods.create.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.create.scopes - resources.advertisers.resources.channels.resources.sites.methods.delete.description - resources.advertisers.resources.channels.resources.sites.methods.delete.flatPath - resources.advertisers.resources.channels.resources.sites.methods.delete.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.delete.id - resources.advertisers.resources.channels.resources.sites.methods.delete.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.partnerId.description - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.partnerId.format - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.partnerId.location - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.partnerId.type - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.description - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.location - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.pattern - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.required - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.type - resources.advertisers.resources.channels.resources.sites.methods.delete.path - resources.advertisers.resources.channels.resources.sites.methods.delete.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.delete.scopes - resources.advertisers.resources.channels.resources.sites.methods.list.description - resources.advertisers.resources.channels.resources.sites.methods.list.flatPath - resources.advertisers.resources.channels.resources.sites.methods.list.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.list.id - resources.advertisers.resources.channels.resources.sites.methods.list.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.filter.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.filter.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.filter.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.orderBy.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.orderBy.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.orderBy.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageSize.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageSize.format - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageSize.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageSize.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageToken.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageToken.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageToken.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.partnerId.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.partnerId.format - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.partnerId.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.partnerId.type - resources.advertisers.resources.channels.resources.sites.methods.list.path - resources.advertisers.resources.channels.resources.sites.methods.list.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.list.scopes - resources.advertisers.resources.locationLists.methods.create.description - resources.advertisers.resources.locationLists.methods.create.flatPath - resources.advertisers.resources.locationLists.methods.create.httpMethod - resources.advertisers.resources.locationLists.methods.create.id - resources.advertisers.resources.locationLists.methods.create.parameterOrder - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.description - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.format - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.location - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.required - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.type - resources.advertisers.resources.locationLists.methods.create.path - resources.advertisers.resources.locationLists.methods.create.request.$ref - resources.advertisers.resources.locationLists.methods.create.response.$ref - resources.advertisers.resources.locationLists.methods.create.scopes - resources.advertisers.resources.locationLists.methods.patch.description - resources.advertisers.resources.locationLists.methods.patch.flatPath - resources.advertisers.resources.locationLists.methods.patch.httpMethod - resources.advertisers.resources.locationLists.methods.patch.id - resources.advertisers.resources.locationLists.methods.patch.parameterOrder - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.description - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.format - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.location - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.required - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.type - resources.advertisers.resources.locationLists.methods.patch.parameters.updateMask.description - resources.advertisers.resources.locationLists.methods.patch.parameters.updateMask.format - resources.advertisers.resources.locationLists.methods.patch.parameters.updateMask.location - resources.advertisers.resources.locationLists.methods.patch.parameters.updateMask.type - resources.advertisers.resources.locationLists.methods.patch.path - resources.advertisers.resources.locationLists.methods.patch.request.$ref - resources.advertisers.resources.locationLists.methods.patch.response.$ref - resources.advertisers.resources.locationLists.methods.patch.scopes - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.flatPath - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.httpMethod - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.id - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameterOrder - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.pattern - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.path - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.request.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.response.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.scopes - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.flatPath - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.httpMethod - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.id - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameterOrder - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.path - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.request.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.response.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.scopes - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.flatPath - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.httpMethod - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.id - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameterOrder - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.pattern - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.path - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.response.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.scopes - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.flatPath - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.httpMethod - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.id - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameterOrder - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.filter.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.filter.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.filter.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.orderBy.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.orderBy.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.orderBy.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageSize.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageSize.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageSize.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageSize.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageToken.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageToken.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageToken.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.path - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.response.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.scopes - resources.advertisers.resources.negativeKeywordLists.methods.create.description - resources.advertisers.resources.negativeKeywordLists.methods.create.flatPath - resources.advertisers.resources.negativeKeywordLists.methods.create.httpMethod - resources.advertisers.resources.negativeKeywordLists.methods.create.id - resources.advertisers.resources.negativeKeywordLists.methods.create.parameterOrder - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.methods.create.path - resources.advertisers.resources.negativeKeywordLists.methods.create.request.$ref - resources.advertisers.resources.negativeKeywordLists.methods.create.response.$ref - resources.advertisers.resources.negativeKeywordLists.methods.create.scopes - resources.advertisers.resources.negativeKeywordLists.methods.delete.description - resources.advertisers.resources.negativeKeywordLists.methods.delete.flatPath - resources.advertisers.resources.negativeKeywordLists.methods.delete.httpMethod - resources.advertisers.resources.negativeKeywordLists.methods.delete.id - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameterOrder - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.methods.delete.path - resources.advertisers.resources.negativeKeywordLists.methods.delete.response.$ref - resources.advertisers.resources.negativeKeywordLists.methods.delete.scopes - resources.advertisers.resources.negativeKeywordLists.methods.patch.description - resources.advertisers.resources.negativeKeywordLists.methods.patch.flatPath - resources.advertisers.resources.negativeKeywordLists.methods.patch.httpMethod - resources.advertisers.resources.negativeKeywordLists.methods.patch.id - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameterOrder - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.updateMask.description - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.updateMask.format - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.updateMask.location - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.updateMask.type - resources.advertisers.resources.negativeKeywordLists.methods.patch.path - resources.advertisers.resources.negativeKeywordLists.methods.patch.request.$ref - resources.advertisers.resources.negativeKeywordLists.methods.patch.response.$ref - resources.advertisers.resources.negativeKeywordLists.methods.patch.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.request.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.request.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.filter.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.filter.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.filter.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.orderBy.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.orderBy.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.orderBy.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageSize.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageSize.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageSize.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageSize.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageToken.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageToken.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageToken.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.scopes - resources.inventorySourceGroups.methods.create.description - resources.inventorySourceGroups.methods.create.flatPath - resources.inventorySourceGroups.methods.create.httpMethod - resources.inventorySourceGroups.methods.create.id - resources.inventorySourceGroups.methods.create.parameterOrder - resources.inventorySourceGroups.methods.create.parameters.advertiserId.description - resources.inventorySourceGroups.methods.create.parameters.advertiserId.format - resources.inventorySourceGroups.methods.create.parameters.advertiserId.location - resources.inventorySourceGroups.methods.create.parameters.advertiserId.type - resources.inventorySourceGroups.methods.create.parameters.partnerId.description - resources.inventorySourceGroups.methods.create.parameters.partnerId.format - resources.inventorySourceGroups.methods.create.parameters.partnerId.location - resources.inventorySourceGroups.methods.create.parameters.partnerId.type - resources.inventorySourceGroups.methods.create.path - resources.inventorySourceGroups.methods.create.request.$ref - resources.inventorySourceGroups.methods.create.response.$ref - resources.inventorySourceGroups.methods.create.scopes - resources.inventorySourceGroups.methods.delete.description - resources.inventorySourceGroups.methods.delete.flatPath - resources.inventorySourceGroups.methods.delete.httpMethod - resources.inventorySourceGroups.methods.delete.id - resources.inventorySourceGroups.methods.delete.parameterOrder - resources.inventorySourceGroups.methods.delete.parameters.advertiserId.description - resources.inventorySourceGroups.methods.delete.parameters.advertiserId.format - resources.inventorySourceGroups.methods.delete.parameters.advertiserId.location - resources.inventorySourceGroups.methods.delete.parameters.advertiserId.type - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.methods.delete.parameters.partnerId.description - resources.inventorySourceGroups.methods.delete.parameters.partnerId.format - resources.inventorySourceGroups.methods.delete.parameters.partnerId.location - resources.inventorySourceGroups.methods.delete.parameters.partnerId.type - resources.inventorySourceGroups.methods.delete.path - resources.inventorySourceGroups.methods.delete.response.$ref - resources.inventorySourceGroups.methods.delete.scopes - resources.inventorySourceGroups.methods.patch.description - resources.inventorySourceGroups.methods.patch.flatPath - resources.inventorySourceGroups.methods.patch.httpMethod - resources.inventorySourceGroups.methods.patch.id - resources.inventorySourceGroups.methods.patch.parameterOrder - resources.inventorySourceGroups.methods.patch.parameters.advertiserId.description - resources.inventorySourceGroups.methods.patch.parameters.advertiserId.format - resources.inventorySourceGroups.methods.patch.parameters.advertiserId.location - resources.inventorySourceGroups.methods.patch.parameters.advertiserId.type - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.methods.patch.parameters.partnerId.description - resources.inventorySourceGroups.methods.patch.parameters.partnerId.format - resources.inventorySourceGroups.methods.patch.parameters.partnerId.location - resources.inventorySourceGroups.methods.patch.parameters.partnerId.type - resources.inventorySourceGroups.methods.patch.parameters.updateMask.description - resources.inventorySourceGroups.methods.patch.parameters.updateMask.format - resources.inventorySourceGroups.methods.patch.parameters.updateMask.location - resources.inventorySourceGroups.methods.patch.parameters.updateMask.type - resources.inventorySourceGroups.methods.patch.path - resources.inventorySourceGroups.methods.patch.request.$ref - resources.inventorySourceGroups.methods.patch.response.$ref - resources.inventorySourceGroups.methods.patch.scopes - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.flatPath - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.httpMethod - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.id - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameterOrder - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.path - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.request.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.response.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.scopes - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.flatPath - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.httpMethod - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.id - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameterOrder - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.advertiserId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.advertiserId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.advertiserId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.advertiserId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.partnerId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.partnerId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.partnerId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.partnerId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.path - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.request.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.response.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.scopes - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.flatPath - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.httpMethod - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.id - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameterOrder - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.advertiserId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.advertiserId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.advertiserId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.advertiserId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.partnerId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.partnerId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.partnerId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.partnerId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.path - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.response.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.scopes - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.flatPath - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.httpMethod - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.id - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameterOrder - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.advertiserId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.advertiserId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.advertiserId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.advertiserId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.filter.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.filter.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.filter.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.orderBy.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.orderBy.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.orderBy.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageSize.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageSize.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageSize.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageSize.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageToken.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageToken.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageToken.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.partnerId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.partnerId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.partnerId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.partnerId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.path - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.response.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.scopes - resources.partners.resources.channels.methods.patch.description - resources.partners.resources.channels.methods.patch.flatPath - resources.partners.resources.channels.methods.patch.httpMethod - resources.partners.resources.channels.methods.patch.id - resources.partners.resources.channels.methods.patch.parameterOrder - resources.partners.resources.channels.methods.patch.parameters.advertiserId.description - resources.partners.resources.channels.methods.patch.parameters.advertiserId.format - resources.partners.resources.channels.methods.patch.parameters.advertiserId.location - resources.partners.resources.channels.methods.patch.parameters.advertiserId.type - resources.partners.resources.channels.methods.patch.parameters.channelId.description - resources.partners.resources.channels.methods.patch.parameters.channelId.format - resources.partners.resources.channels.methods.patch.parameters.channelId.location - resources.partners.resources.channels.methods.patch.parameters.channelId.required - resources.partners.resources.channels.methods.patch.parameters.channelId.type - resources.partners.resources.channels.methods.patch.parameters.partnerId.description - resources.partners.resources.channels.methods.patch.parameters.partnerId.format - resources.partners.resources.channels.methods.patch.parameters.partnerId.location - resources.partners.resources.channels.methods.patch.parameters.partnerId.pattern - resources.partners.resources.channels.methods.patch.parameters.partnerId.required - resources.partners.resources.channels.methods.patch.parameters.partnerId.type - resources.partners.resources.channels.methods.patch.parameters.updateMask.description - resources.partners.resources.channels.methods.patch.parameters.updateMask.format - resources.partners.resources.channels.methods.patch.parameters.updateMask.location - resources.partners.resources.channels.methods.patch.parameters.updateMask.type - resources.partners.resources.channels.methods.patch.path - resources.partners.resources.channels.methods.patch.request.$ref - resources.partners.resources.channels.methods.patch.response.$ref - resources.partners.resources.channels.methods.patch.scopes - resources.partners.resources.channels.resources.sites.methods.bulkEdit.description - resources.partners.resources.channels.resources.sites.methods.bulkEdit.flatPath - resources.partners.resources.channels.resources.sites.methods.bulkEdit.httpMethod - resources.partners.resources.channels.resources.sites.methods.bulkEdit.id - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameterOrder - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.bulkEdit.path - resources.partners.resources.channels.resources.sites.methods.bulkEdit.request.$ref - resources.partners.resources.channels.resources.sites.methods.bulkEdit.response.$ref - resources.partners.resources.channels.resources.sites.methods.bulkEdit.scopes - resources.partners.resources.channels.resources.sites.methods.create.description - resources.partners.resources.channels.resources.sites.methods.create.flatPath - resources.partners.resources.channels.resources.sites.methods.create.httpMethod - resources.partners.resources.channels.resources.sites.methods.create.id - resources.partners.resources.channels.resources.sites.methods.create.parameterOrder - resources.partners.resources.channels.resources.sites.methods.create.parameters.advertiserId.description - resources.partners.resources.channels.resources.sites.methods.create.parameters.advertiserId.format - resources.partners.resources.channels.resources.sites.methods.create.parameters.advertiserId.location - resources.partners.resources.channels.resources.sites.methods.create.parameters.advertiserId.type - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.create.path - resources.partners.resources.channels.resources.sites.methods.create.request.$ref - resources.partners.resources.channels.resources.sites.methods.create.response.$ref - resources.partners.resources.channels.resources.sites.methods.create.scopes - resources.partners.resources.channels.resources.sites.methods.delete.description - resources.partners.resources.channels.resources.sites.methods.delete.flatPath - resources.partners.resources.channels.resources.sites.methods.delete.httpMethod - resources.partners.resources.channels.resources.sites.methods.delete.id - resources.partners.resources.channels.resources.sites.methods.delete.parameterOrder - resources.partners.resources.channels.resources.sites.methods.delete.parameters.advertiserId.description - resources.partners.resources.channels.resources.sites.methods.delete.parameters.advertiserId.format - resources.partners.resources.channels.resources.sites.methods.delete.parameters.advertiserId.location - resources.partners.resources.channels.resources.sites.methods.delete.parameters.advertiserId.type - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.description - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.location - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.pattern - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.required - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.type - resources.partners.resources.channels.resources.sites.methods.delete.path - resources.partners.resources.channels.resources.sites.methods.delete.response.$ref - resources.partners.resources.channels.resources.sites.methods.delete.scopes - resources.partners.resources.channels.resources.sites.methods.list.description - resources.partners.resources.channels.resources.sites.methods.list.flatPath - resources.partners.resources.channels.resources.sites.methods.list.httpMethod - resources.partners.resources.channels.resources.sites.methods.list.id - resources.partners.resources.channels.resources.sites.methods.list.parameterOrder - resources.partners.resources.channels.resources.sites.methods.list.parameters.advertiserId.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.advertiserId.format - resources.partners.resources.channels.resources.sites.methods.list.parameters.advertiserId.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.advertiserId.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.filter.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.filter.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.filter.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.orderBy.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.orderBy.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.orderBy.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageSize.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageSize.format - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageSize.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageSize.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageToken.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageToken.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageToken.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.pattern - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.list.path - resources.partners.resources.channels.resources.sites.methods.list.response.$ref - resources.partners.resources.channels.resources.sites.methods.list.scopes - schemas.AssignedInventorySource.description - schemas.AssignedInventorySource.id - schemas.AssignedInventorySource.properties.assignedInventorySourceId.description - schemas.AssignedInventorySource.properties.assignedInventorySourceId.format - schemas.AssignedInventorySource.properties.assignedInventorySourceId.type - schemas.AssignedInventorySource.properties.inventorySourceId.description - schemas.AssignedInventorySource.properties.inventorySourceId.type - schemas.AssignedInventorySource.properties.name.description - schemas.AssignedInventorySource.properties.name.type - schemas.AssignedInventorySource.type - schemas.AssignedLocation.description - schemas.AssignedLocation.id - schemas.AssignedLocation.properties.assignedLocationId.description - schemas.AssignedLocation.properties.assignedLocationId.format - schemas.AssignedLocation.properties.assignedLocationId.type - schemas.AssignedLocation.properties.name.description - schemas.AssignedLocation.properties.name.type - schemas.AssignedLocation.properties.targetingOptionId.description - schemas.AssignedLocation.properties.targetingOptionId.type - schemas.AssignedLocation.type - schemas.BulkEditAssignedInventorySourcesRequest.description - schemas.BulkEditAssignedInventorySourcesRequest.id - schemas.BulkEditAssignedInventorySourcesRequest.properties.advertiserId.description - schemas.BulkEditAssignedInventorySourcesRequest.properties.advertiserId.format - schemas.BulkEditAssignedInventorySourcesRequest.properties.advertiserId.type - schemas.BulkEditAssignedInventorySourcesRequest.properties.createdAssignedInventorySources.description - schemas.BulkEditAssignedInventorySourcesRequest.properties.createdAssignedInventorySources.items.$ref - schemas.BulkEditAssignedInventorySourcesRequest.properties.createdAssignedInventorySources.type - schemas.BulkEditAssignedInventorySourcesRequest.properties.deletedAssignedInventorySources.description - schemas.BulkEditAssignedInventorySourcesRequest.properties.deletedAssignedInventorySources.items.format - schemas.BulkEditAssignedInventorySourcesRequest.properties.deletedAssignedInventorySources.items.type - schemas.BulkEditAssignedInventorySourcesRequest.properties.deletedAssignedInventorySources.type - schemas.BulkEditAssignedInventorySourcesRequest.properties.partnerId.description - schemas.BulkEditAssignedInventorySourcesRequest.properties.partnerId.format - schemas.BulkEditAssignedInventorySourcesRequest.properties.partnerId.type - schemas.BulkEditAssignedInventorySourcesRequest.type - schemas.BulkEditAssignedInventorySourcesResponse.description - schemas.BulkEditAssignedInventorySourcesResponse.id - schemas.BulkEditAssignedInventorySourcesResponse.properties.assignedInventorySources.description - schemas.BulkEditAssignedInventorySourcesResponse.properties.assignedInventorySources.items.$ref - schemas.BulkEditAssignedInventorySourcesResponse.properties.assignedInventorySources.type - schemas.BulkEditAssignedInventorySourcesResponse.type - schemas.BulkEditAssignedLocationsRequest.description - schemas.BulkEditAssignedLocationsRequest.id - schemas.BulkEditAssignedLocationsRequest.properties.createdAssignedLocations.description - schemas.BulkEditAssignedLocationsRequest.properties.createdAssignedLocations.items.$ref - schemas.BulkEditAssignedLocationsRequest.properties.createdAssignedLocations.type - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.description - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.items.format - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.items.type - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.type - schemas.BulkEditAssignedLocationsRequest.type - schemas.BulkEditAssignedLocationsResponse.description - schemas.BulkEditAssignedLocationsResponse.id - schemas.BulkEditAssignedLocationsResponse.properties.assignedLocations.description - schemas.BulkEditAssignedLocationsResponse.properties.assignedLocations.items.$ref - schemas.BulkEditAssignedLocationsResponse.properties.assignedLocations.type - schemas.BulkEditAssignedLocationsResponse.type - schemas.BulkEditNegativeKeywordsRequest.description - schemas.BulkEditNegativeKeywordsRequest.id - schemas.BulkEditNegativeKeywordsRequest.properties.createdNegativeKeywords.description - schemas.BulkEditNegativeKeywordsRequest.properties.createdNegativeKeywords.items.$ref - schemas.BulkEditNegativeKeywordsRequest.properties.createdNegativeKeywords.type - schemas.BulkEditNegativeKeywordsRequest.properties.deletedNegativeKeywords.description - schemas.BulkEditNegativeKeywordsRequest.properties.deletedNegativeKeywords.items.type - schemas.BulkEditNegativeKeywordsRequest.properties.deletedNegativeKeywords.type - schemas.BulkEditNegativeKeywordsRequest.type - schemas.BulkEditNegativeKeywordsResponse.description - schemas.BulkEditNegativeKeywordsResponse.id - schemas.BulkEditNegativeKeywordsResponse.properties.negativeKeywords.description - schemas.BulkEditNegativeKeywordsResponse.properties.negativeKeywords.items.$ref - schemas.BulkEditNegativeKeywordsResponse.properties.negativeKeywords.type - schemas.BulkEditNegativeKeywordsResponse.type - schemas.BulkEditSitesRequest.description - schemas.BulkEditSitesRequest.id - schemas.BulkEditSitesRequest.properties.advertiserId.description - schemas.BulkEditSitesRequest.properties.advertiserId.format - schemas.BulkEditSitesRequest.properties.advertiserId.type - schemas.BulkEditSitesRequest.properties.createdSites.description - schemas.BulkEditSitesRequest.properties.createdSites.items.$ref - schemas.BulkEditSitesRequest.properties.createdSites.type - schemas.BulkEditSitesRequest.properties.deletedSites.description - schemas.BulkEditSitesRequest.properties.deletedSites.items.type - schemas.BulkEditSitesRequest.properties.deletedSites.type - schemas.BulkEditSitesRequest.properties.partnerId.description - schemas.BulkEditSitesRequest.properties.partnerId.format - schemas.BulkEditSitesRequest.properties.partnerId.type - schemas.BulkEditSitesRequest.type - schemas.BulkEditSitesResponse.description - schemas.BulkEditSitesResponse.id - schemas.BulkEditSitesResponse.properties.sites.description - schemas.BulkEditSitesResponse.properties.sites.items.$ref - schemas.BulkEditSitesResponse.properties.sites.type - schemas.BulkEditSitesResponse.type - schemas.ListAssignedInventorySourcesResponse.description - schemas.ListAssignedInventorySourcesResponse.id - schemas.ListAssignedInventorySourcesResponse.properties.assignedInventorySources.description - schemas.ListAssignedInventorySourcesResponse.properties.assignedInventorySources.items.$ref - schemas.ListAssignedInventorySourcesResponse.properties.assignedInventorySources.type - schemas.ListAssignedInventorySourcesResponse.properties.nextPageToken.description - schemas.ListAssignedInventorySourcesResponse.properties.nextPageToken.type - schemas.ListAssignedInventorySourcesResponse.type - schemas.ListAssignedLocationsResponse.description - schemas.ListAssignedLocationsResponse.id - schemas.ListAssignedLocationsResponse.properties.assignedLocations.description - schemas.ListAssignedLocationsResponse.properties.assignedLocations.items.$ref - schemas.ListAssignedLocationsResponse.properties.assignedLocations.type - schemas.ListAssignedLocationsResponse.properties.nextPageToken.description - schemas.ListAssignedLocationsResponse.properties.nextPageToken.type - schemas.ListAssignedLocationsResponse.type - schemas.ListNegativeKeywordsResponse.description - schemas.ListNegativeKeywordsResponse.id - schemas.ListNegativeKeywordsResponse.properties.negativeKeywords.description - schemas.ListNegativeKeywordsResponse.properties.negativeKeywords.items.$ref - schemas.ListNegativeKeywordsResponse.properties.negativeKeywords.type - schemas.ListNegativeKeywordsResponse.properties.nextPageToken.description - schemas.ListNegativeKeywordsResponse.properties.nextPageToken.type - schemas.ListNegativeKeywordsResponse.type - schemas.ListSitesResponse.description - schemas.ListSitesResponse.id - schemas.ListSitesResponse.properties.nextPageToken.description - schemas.ListSitesResponse.properties.nextPageToken.type - schemas.ListSitesResponse.properties.sites.description - schemas.ListSitesResponse.properties.sites.items.$ref - schemas.ListSitesResponse.properties.sites.type - schemas.ListSitesResponse.type - schemas.NegativeKeyword.description - schemas.NegativeKeyword.id - schemas.NegativeKeyword.properties.keywordValue.description - schemas.NegativeKeyword.properties.keywordValue.type - schemas.NegativeKeyword.properties.name.description - schemas.NegativeKeyword.properties.name.type - schemas.NegativeKeyword.type - schemas.Site.description - schemas.Site.id - schemas.Site.properties.name.description - schemas.Site.properties.name.type - schemas.Site.properties.urlOrAppId.description - schemas.Site.properties.urlOrAppId.type - schemas.Site.type The following keys were changed: - schemas.ExchangeReviewStatus.properties.exchange.enum - schemas.ExchangeReviewStatus.properties.exchange.enumDescriptions - schemas.ExchangeTargetingOptionDetails.properties.exchange.enum - schemas.ExchangeTargetingOptionDetails.properties.exchange.enumDescriptions - schemas.InventorySource.properties.exchange.enum - schemas.InventorySource.properties.exchange.enumDescriptions --- discovery/displayvideo-v1.json | 1797 +++- src/apis/displayvideo/v1.ts | 13612 ++++++++++++++++++++++--------- 2 files changed, 11292 insertions(+), 4117 deletions(-) diff --git a/discovery/displayvideo-v1.json b/discovery/displayvideo-v1.json index b346399575..989beaad30 100644 --- a/discovery/displayvideo-v1.json +++ b/discovery/displayvideo-v1.json @@ -670,6 +670,251 @@ "scopes": [ "https://www.googleapis.com/auth/display-video" ] + }, + "patch": { + "description": "Updates a channel. Returns the updated channel if successful.", + "flatPath": "v1/advertisers/{advertisersId}/channels/{channelId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.channels.patch", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the created channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Output only. The unique ID of the channel. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the created channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/channels/{channelId}", + "request": { + "$ref": "Channel" + }, + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "sites": { + "methods": { + "bulkEdit": { + "description": "Bulk edits sites under a single channel.\n\nThe operation will delete the sites provided in\nBulkEditSitesRequest.deleted_sites and then create the sites\nprovided in BulkEditSitesRequest.created_sites.", + "flatPath": "v1/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.advertisers.channels.sites.bulkEdit", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit", + "request": { + "$ref": "BulkEditSitesRequest" + }, + "response": { + "$ref": "BulkEditSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a site in a channel.", + "flatPath": "v1/advertisers/{advertiserId}/channels/{channelsId}/sites", + "httpMethod": "POST", + "id": "displayvideo.advertisers.channels.sites.create", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel in which the site will be created.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/channels/{+channelId}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a site from a channel.", + "flatPath": "v1/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.channels.sites.delete", + "parameterOrder": [ + "advertiserId", + "channelId", + "urlOrAppId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the site belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "urlOrAppId": { + "description": "Required. The URL or app ID of the site to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists sites in a channel.", + "flatPath": "v1/advertisers/{advertisersId}/channels/{channelsId}/sites", + "httpMethod": "GET", + "id": "displayvideo.advertisers.channels.sites.list", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the requested sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by site fields.\n\nSupported syntax:\n\n* Filter expressions for site currently can only contain at most one\n* restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `urlOrAppId`\n\nExamples:\n\n* All sites for which the URL or app ID contains \"google\":\n`urlOrAppId : \"google\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list.\nAcceptable values are:\n\n* `urlOrAppId` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`urlOrAppId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token returned from the\nprevious call to `ListSites` method. If not specified, the first page\nof results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/channels/{+channelId}/sites", + "response": { + "$ref": "ListSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } } } }, @@ -1733,6 +1978,35 @@ }, "locationLists": { "methods": { + "create": { + "description": "Creates a new location list. Returns the newly created location list if\nsuccessful.", + "flatPath": "v1/advertisers/{advertisersId}/locationLists", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/locationLists", + "request": { + "$ref": "LocationList" + }, + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, "get": { "description": "Gets a location list.", "flatPath": "v1/advertisers/{advertisersId}/locationLists/{locationListsId}", @@ -1814,56 +2088,338 @@ "scopes": [ "https://www.googleapis.com/auth/display-video" ] - } - } - }, - "negativeKeywordLists": { - "methods": { - "get": { - "description": "Gets a negative keyword list given an advertiser ID and a negative keyword\nlist ID.", - "flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}", - "httpMethod": "GET", - "id": "displayvideo.advertisers.negativeKeywordLists.get", + }, + "patch": { + "description": "Updates a location list. Returns the updated location list if successful.", + "flatPath": "v1/advertisers/{advertisersId}/locationLists/{locationListId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.locationLists.patch", "parameterOrder": [ "advertiserId", - "negativeKeywordListId" + "locationListId" ], "parameters": { "advertiserId": { - "description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword list\nbelongs.", + "description": "Required. The ID of the DV360 advertiser to which the location lists belongs.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, - "negativeKeywordListId": { - "description": "Required. The ID of the negative keyword list to fetch.", + "locationListId": { + "description": "Output only. The unique ID of the location list. Assigned by the system.", "format": "int64", "location": "path", - "pattern": "^[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}", + "path": "v1/advertisers/{+advertiserId}/locationLists/{locationListId}", + "request": { + "$ref": "LocationList" + }, "response": { - "$ref": "NegativeKeywordList" + "$ref": "LocationList" }, "scopes": [ "https://www.googleapis.com/auth/display-video" ] - }, - "list": { - "description": "Lists negative keyword lists based on a given advertiser id.", - "flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists", - "httpMethod": "GET", - "id": "displayvideo.advertisers.negativeKeywordLists.list", - "parameterOrder": [ - "advertiserId" - ], - "parameters": { - "advertiserId": { + } + }, + "resources": { + "assignedLocations": { + "methods": { + "bulkEdit": { + "description": "Bulk edits multiple assignments between locations and a single location\nlist.\n\nThe operation will delete the assigned locations provided in\nBulkEditAssignedLocationsRequest.deleted_assigned_locations and then\ncreate the assigned locations provided in\nBulkEditAssignedLocationsRequest.created_assigned_locations.", + "flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.assignedLocations.bulkEdit", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to which these assignments are assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit", + "request": { + "$ref": "BulkEditAssignedLocationsRequest" + }, + "response": { + "$ref": "BulkEditAssignedLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates an assignment between a location and a location list.", + "flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.assignedLocations.create", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list for which the assignment will be created.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "request": { + "$ref": "AssignedLocation" + }, + "response": { + "$ref": "AssignedLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes the assignment between a location and a location list.", + "flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.locationLists.assignedLocations.delete", + "parameterOrder": [ + "advertiserId", + "locationListId", + "assignedLocationId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "assignedLocationId": { + "description": "Required. The ID of the assigned location to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to which this assignment is assigned.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists locations assigned to a location list.", + "flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "httpMethod": "GET", + "id": "displayvideo.advertisers.locationLists.assignedLocations.list", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by location list assignment fields.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `assignedLocationId`\n\nThe length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to which these assignments are assigned.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list.\nAcceptable values are:\n\n* `assignedLocationId` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`assignedLocationId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListAssignedLocations`\nmethod. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "response": { + "$ref": "ListAssignedLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "negativeKeywordLists": { + "methods": { + "create": { + "description": "Creates a new negative keyword list. Returns the newly created negative\nkeyword list if successful.", + "flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists", + "httpMethod": "POST", + "id": "displayvideo.advertisers.negativeKeywordLists.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the negative keyword list will\nbelong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/negativeKeywordLists", + "request": { + "$ref": "NegativeKeywordList" + }, + "response": { + "$ref": "NegativeKeywordList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a negative keyword list given an advertiser ID and a negative\nkeyword list ID.", + "flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.negativeKeywordLists.delete", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the negative keyword list to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a negative keyword list given an advertiser ID and a negative keyword\nlist ID.", + "flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.negativeKeywordLists.get", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword list\nbelongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the negative keyword list to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}", + "response": { + "$ref": "NegativeKeywordList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists negative keyword lists based on a given advertiser id.", + "flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists", + "httpMethod": "GET", + "id": "displayvideo.advertisers.negativeKeywordLists.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { "description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword lists\nbelong.", "format": "int64", "location": "path", @@ -1871,25 +2427,246 @@ "required": true, "type": "string" }, - "pageSize": { - "description": "Requested page size. Must be between `1` and `100`.\nDefaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an\ninvalid value is specified.", - "format": "int32", - "location": "query", - "type": "integer" + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`.\nDefaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an\ninvalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListNegativeKeywordLists` method.\nIf not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/negativeKeywordLists", + "response": { + "$ref": "ListNegativeKeywordListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a negative keyword list. Returns the updated negative keyword list\nif successful.", + "flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.negativeKeywordLists.patch", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Output only. The unique ID of the negative keyword list. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}", + "request": { + "$ref": "NegativeKeywordList" + }, + "response": { + "$ref": "NegativeKeywordList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "negativeKeywords": { + "methods": { + "bulkEdit": { + "description": "Bulk edits negative keywords in a single negative keyword list.\n\nThe operation will delete the negative keywords provided in\nBulkEditNegativeKeywordsRequest.deleted_negative_keywords and then\ncreate the negative keywords provided in\nBulkEditNegativeKeywordsRequest.created_negative_keywords.\n\nThis operation is guaranteed to be atomic and will never result in a\npartial success or partial failure.", + "flatPath": "v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list\nbelongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list to which the negative keywords\nbelong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit", + "request": { + "$ref": "BulkEditNegativeKeywordsRequest" + }, + "response": { + "$ref": "BulkEditNegativeKeywordsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a negative keyword in a negative keyword list.", + "flatPath": "v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords", + "httpMethod": "POST", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list\nbelongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list in which the negative keyword\nwill be created.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords", + "request": { + "$ref": "NegativeKeyword" + }, + "response": { + "$ref": "NegativeKeyword" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a negative keyword from a negative keyword list.", + "flatPath": "v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId", + "keywordValue" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list\nbelongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "keywordValue": { + "description": "Required. The keyword value of the negative keyword to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list to which the negative keyword\nbelongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListNegativeKeywordLists` method.\nIf not specified, the first page of results will be returned.", - "location": "query", - "type": "string" + "list": { + "description": "Lists negative keywords in a negative keyword list.", + "flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords", + "httpMethod": "GET", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list\nbelongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by negative keyword fields.\n\nSupported syntax:\n\n* Filter expressions for negative keyword currently can only contain at\nmost one\n* restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `keywordValue`\n\nExamples:\n\n* All negative keywords for which the keyword value contains \"google\":\n`keywordValue : \"google\"`", + "location": "query", + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list to which the requested negative\nkeywords belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list.\nAcceptable values are:\n\n* `keywordValue` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`keywordValue desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token returned\nfrom the previous call to `ListNegativeKeywords` method. If not specified,\nthe first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords", + "response": { + "$ref": "ListNegativeKeywordsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] } - }, - "path": "v1/advertisers/{+advertiserId}/negativeKeywordLists", - "response": { - "$ref": "ListNegativeKeywordListsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video" - ] + } } } }, @@ -2669,6 +3446,75 @@ }, "inventorySourceGroups": { "methods": { + "create": { + "description": "Creates a new inventory source group. Returns the newly created inventory\nsource group if successful.", + "flatPath": "v1/inventorySourceGroups", + "httpMethod": "POST", + "id": "displayvideo.inventorySourceGroups.create", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the inventory source group.\n\nThe parent partner will not have access to this group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the inventory source group.\n\nOnly this partner will have write access to this group. Only advertisers\nto which this group is explicitly shared will have read access to this\ngroup.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/inventorySourceGroups", + "request": { + "$ref": "InventorySourceGroup" + }, + "response": { + "$ref": "InventorySourceGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an inventory source group.", + "flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}", + "httpMethod": "DELETE", + "id": "displayvideo.inventorySourceGroups.delete", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the inventory source group.\n\nThe parent partner does not have access to this group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the inventory source group.\n\nOnly this partner has write access to this group.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/inventorySourceGroups/{+inventorySourceGroupId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, "get": { "description": "Gets an inventory source group.", "flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}", @@ -2736,25 +3582,253 @@ "location": "query", "type": "integer" }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListInventorySources` method.\nIf not specified, the first page of results will be returned.", - "location": "query", - "type": "string" + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListInventorySources` method.\nIf not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the inventory source group.\n\nA partner cannot access advertiser-owned inventory source groups.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/inventorySourceGroups", + "response": { + "$ref": "ListInventorySourceGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an inventory source group. Returns the updated inventory source\ngroup if successful.", + "flatPath": "v1/inventorySourceGroups/{inventorySourceGroupId}", + "httpMethod": "PATCH", + "id": "displayvideo.inventorySourceGroups.patch", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the inventory source group.\n\nThe parent partner does not have access to this group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Output only. The unique ID of the inventory source group. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the inventory source group.\n\nOnly this partner has write access to this group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/inventorySourceGroups/{inventorySourceGroupId}", + "request": { + "$ref": "InventorySourceGroup" + }, + "response": { + "$ref": "InventorySourceGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "assignedInventorySources": { + "methods": { + "bulkEdit": { + "description": "Bulk edits multiple assignments between inventory sources and a single\ninventory source group.\n\nThe operation will delete the assigned inventory sources provided in\nBulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources\nand then create the assigned inventory sources provided in\nBulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.", + "flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which the assignments are\nassigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit", + "request": { + "$ref": "BulkEditAssignedInventorySourcesRequest" + }, + "response": { + "$ref": "BulkEditAssignedInventorySourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates an assignment between an inventory source and an inventory source\ngroup.", + "flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources", + "httpMethod": "POST", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.create", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent inventory source group.\n\nThe parent partner will not have access to this assigned inventory\nsource.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which the assignment will be\nassigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent inventory source group.\n\nOnly this partner will have write access to this assigned inventory\nsource.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources", + "request": { + "$ref": "AssignedInventorySource" + }, + "response": { + "$ref": "AssignedInventorySource" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes the assignment between an inventory source and an inventory source\ngroup.", + "flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}", + "httpMethod": "DELETE", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.delete", + "parameterOrder": [ + "inventorySourceGroupId", + "assignedInventorySourceId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent inventory source group.\n\nThe parent partner does not have access to this assigned inventory\nsource.", + "format": "int64", + "location": "query", + "type": "string" + }, + "assignedInventorySourceId": { + "description": "Required. The ID of the assigned inventory source to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which this assignment is assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent inventory source group.\n\nOnly this partner has write access to this assigned inventory source.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] }, - "partnerId": { - "description": "The ID of the partner that has access to the inventory source group.\n\nA partner cannot access advertiser-owned inventory source groups.", - "format": "int64", - "location": "query", - "type": "string" + "list": { + "description": "Lists inventory sources assigned to an inventory source group.", + "flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources", + "httpMethod": "GET", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.list", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the assignment.\n\nIf the parent inventory source group is partner-owned, only advertisers\nto which the parent group is explicitly shared can access the assigned\ninventory source.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned inventory source fields.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `assignedInventorySourceId`\n\nThe length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which these assignments are\nassigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list.\nAcceptable values are:\n\n* `assignedInventorySourceId` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`assignedInventorySourceId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListAssignedInventorySources`\nmethod. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the assignment.\n\nIf the parent inventory source group is advertiser-owned, the assignment\ncannot be accessed via a partner.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources", + "response": { + "$ref": "ListAssignedInventorySourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] } - }, - "path": "v1/inventorySourceGroups", - "response": { - "$ref": "ListInventorySourceGroupsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video" - ] + } } } }, @@ -2955,22 +4029,267 @@ "location": "query", "type": "string" }, - "partnerId": { - "description": "The ID of the partner that owns the channels.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" + "partnerId": { + "description": "The ID of the partner that owns the channels.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/partners/{+partnerId}/channels", + "response": { + "$ref": "ListChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a channel. Returns the updated channel if successful.", + "flatPath": "v1/partners/{partnersId}/channels/{channelId}", + "httpMethod": "PATCH", + "id": "displayvideo.partners.channels.patch", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the created channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Output only. The unique ID of the channel. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the created channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/partners/{+partnerId}/channels/{channelId}", + "request": { + "$ref": "Channel" + }, + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "sites": { + "methods": { + "bulkEdit": { + "description": "Bulk edits sites under a single channel.\n\nThe operation will delete the sites provided in\nBulkEditSitesRequest.deleted_sites and then create the sites\nprovided in BulkEditSitesRequest.created_sites.", + "flatPath": "v1/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.partners.channels.sites.bulkEdit", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "channelId": { + "description": "Required. The ID of the parent channel to which the sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit", + "request": { + "$ref": "BulkEditSitesRequest" + }, + "response": { + "$ref": "BulkEditSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a site in a channel.", + "flatPath": "v1/partners/{partnerId}/channels/{channelsId}/sites", + "httpMethod": "POST", + "id": "displayvideo.partners.channels.sites.create", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel in which the site will be created.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/partners/{partnerId}/channels/{+channelId}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a site from a channel.", + "flatPath": "v1/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}", + "httpMethod": "DELETE", + "id": "displayvideo.partners.channels.sites.delete", + "parameterOrder": [ + "partnerId", + "channelId", + "urlOrAppId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the site belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "urlOrAppId": { + "description": "Required. The URL or app ID of the site to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists sites in a channel.", + "flatPath": "v1/partners/{partnersId}/channels/{channelsId}/sites", + "httpMethod": "GET", + "id": "displayvideo.partners.channels.sites.list", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the requested sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by site fields.\n\nSupported syntax:\n\n* Filter expressions for site currently can only contain at most one\n* restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `urlOrAppId`\n\nExamples:\n\n* All sites for which the URL or app ID contains \"google\":\n`urlOrAppId : \"google\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list.\nAcceptable values are:\n\n* `urlOrAppId` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`urlOrAppId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token returned from the\nprevious call to `ListSites` method. If not specified, the first page\nof results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/partners/{+partnerId}/channels/{+channelId}/sites", + "response": { + "$ref": "ListSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] } - }, - "path": "v1/partners/{+partnerId}/channels", - "response": { - "$ref": "ListChannelsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video" - ] + } } } } @@ -3210,7 +4529,7 @@ } } }, - "revision": "20200528", + "revision": "20200602", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -3717,6 +5036,46 @@ }, "type": "object" }, + "AssignedInventorySource": { + "description": "An assignment between a targetable inventory source and an inventory source\ngroup.", + "id": "AssignedInventorySource", + "properties": { + "assignedInventorySourceId": { + "description": "Output only. The unique ID of the assigned inventory source. The ID is only\nunique within a given inventory source group. It may be reused in other\ncontexts.", + "format": "int64", + "type": "string" + }, + "inventorySourceId": { + "description": "Required. The ID of the inventory source entity being targeted.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the assigned inventory source.", + "type": "string" + } + }, + "type": "object" + }, + "AssignedLocation": { + "description": "An assignment between a location list and a relevant targeting option.\nCurrently, geo region targeting options are the only supported option for\nassignment.", + "id": "AssignedLocation", + "properties": { + "assignedLocationId": { + "description": "Output only. The unique ID of the assigned location. The ID is only unique within a\nlocation list. It may be reused in other contexts.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the assigned location.", + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The ID of the targeting option assigned to the location list. Must be of\ntype TARGETING_TYPE_GEO_REGION.", + "type": "string" + } + }, + "type": "object" + }, "AssignedTargetingOption": { "description": "A single assigned targeting option, which defines the state of a targeting\noption for an entity with targeting settings, such as a Line Item or\nInsertion Order.", "id": "AssignedTargetingOption", @@ -4160,6 +5519,88 @@ }, "type": "object" }, + "BulkEditAssignedInventorySourcesRequest": { + "description": "Request message for AssignedInventorySourceService.BulkEdit.", + "id": "BulkEditAssignedInventorySourcesRequest", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent inventory source group.\n\nThe parent partner does not have access to these assigned inventory\nsources.", + "format": "int64", + "type": "string" + }, + "createdAssignedInventorySources": { + "description": "The assigned inventory sources to create in bulk, specified as a list of\nAssignedInventorySources.", + "items": { + "$ref": "AssignedInventorySource" + }, + "type": "array" + }, + "deletedAssignedInventorySources": { + "description": "The IDs of the assigned inventory sources to delete in bulk, specified as a\nlist of\nassigned_inventory_source_ids.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "partnerId": { + "description": "The ID of the partner that owns the inventory source group.\n\nOnly this partner has write access to these assigned inventory sources.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BulkEditAssignedInventorySourcesResponse": { + "description": "Response message for AssignedInventorySourceService.BulkEdit.", + "id": "BulkEditAssignedInventorySourcesResponse", + "properties": { + "assignedInventorySources": { + "description": "The list of assigned inventory sources that have been successfully created.\n\nThis list will be absent if empty.", + "items": { + "$ref": "AssignedInventorySource" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedLocationsRequest": { + "description": "Request message for AssignedLocationService.BulkEditAssignedLocations.", + "id": "BulkEditAssignedLocationsRequest", + "properties": { + "createdAssignedLocations": { + "description": "The assigned locations to create in bulk, specified as a list of\nAssignedLocations.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + }, + "deletedAssignedLocations": { + "description": "The IDs of the assigned locations to delete in bulk, specified as a list of\nassigned_location_ids.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedLocationsResponse": { + "description": "Response message for AssignedLocationService.BulkEditAssignedLocations.", + "id": "BulkEditAssignedLocationsResponse", + "properties": { + "assignedLocations": { + "description": "The list of assigned locations that have been successfully created.\n\nThis list will be absent if empty.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + } + }, + "type": "object" + }, "BulkEditLineItemAssignedTargetingOptionsRequest": { "description": "Request message for\nBulkEditLineItemAssignedTargetingOptions.", "id": "BulkEditLineItemAssignedTargetingOptionsRequest", @@ -4194,6 +5635,86 @@ }, "type": "object" }, + "BulkEditNegativeKeywordsRequest": { + "description": "Request message for NegativeKeywordService.BulkEditNegativeKeywords.", + "id": "BulkEditNegativeKeywordsRequest", + "properties": { + "createdNegativeKeywords": { + "description": "The negative keywords to create in batch, specified as a list of\nNegativeKeywords.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + }, + "deletedNegativeKeywords": { + "description": "The negative keywords to delete in batch, specified as a list of\nkeyword_values.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditNegativeKeywordsResponse": { + "description": "Response message for NegativeKeywordService.BulkEditNegativeKeywords.", + "id": "BulkEditNegativeKeywordsResponse", + "properties": { + "negativeKeywords": { + "description": "The list of negative keywords that have been successfully created.\n\nThis list will be absent if empty.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditSitesRequest": { + "description": "Request message for SiteService.BulkEditSites.", + "id": "BulkEditSitesRequest", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "type": "string" + }, + "createdSites": { + "description": "The sites to create in batch, specified as a list of Sites.", + "items": { + "$ref": "Site" + }, + "type": "array" + }, + "deletedSites": { + "description": "The sites to delete in batch, specified as a list of site\nurl_or_app_ids.", + "items": { + "type": "string" + }, + "type": "array" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BulkEditSitesResponse": { + "description": "Response message for SiteService.BulkEditSites.", + "id": "BulkEditSitesResponse", + "properties": { + "sites": { + "description": "The list of sites that have been successfully created.\n\nThis list will be absent if empty.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, "BulkListAdvertiserAssignedTargetingOptionsResponse": { "id": "BulkListAdvertiserAssignedTargetingOptionsResponse", "properties": { @@ -6120,6 +7641,9 @@ "EXCHANGE_UNITED", "EXCHANGE_YIELDLAB", "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", "EXCHANGE_TRIPLELIFT", "EXCHANGE_TABOOLA", "EXCHANGE_INMOBI", @@ -6179,6 +7703,9 @@ "United.", "Yieldlab.", "Yieldmo.", + "UnrulyX", + "Open8", + "Triton.", "TripleLift", "Taboola", "InMobi.", @@ -6265,6 +7792,9 @@ "EXCHANGE_UNITED", "EXCHANGE_YIELDLAB", "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", "EXCHANGE_TRIPLELIFT", "EXCHANGE_TABOOLA", "EXCHANGE_INMOBI", @@ -6324,6 +7854,9 @@ "United.", "Yieldlab.", "Yieldmo.", + "UnrulyX", + "Open8", + "Triton.", "TripleLift", "Taboola", "InMobi.", @@ -7478,6 +9011,9 @@ "EXCHANGE_UNITED", "EXCHANGE_YIELDLAB", "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", "EXCHANGE_TRIPLELIFT", "EXCHANGE_TABOOLA", "EXCHANGE_INMOBI", @@ -7537,6 +9073,9 @@ "United.", "Yieldlab.", "Yieldmo.", + "UnrulyX", + "Open8", + "Triton.", "TripleLift", "Taboola", "InMobi.", @@ -8029,6 +9568,42 @@ }, "type": "object" }, + "ListAssignedInventorySourcesResponse": { + "description": "Response message for\nAssignedInventorySourceService.ListAssignedInventorySources.", + "id": "ListAssignedInventorySourcesResponse", + "properties": { + "assignedInventorySources": { + "description": "The list of assigned inventory sources.\n\nThis list will be absent if empty.", + "items": { + "$ref": "AssignedInventorySource" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.\n\nPass this value in the\npage_token field\nin the subsequent call to `ListAssignedInventorySources` method to\nretrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAssignedLocationsResponse": { + "description": "Response message for\nAssignedLocationService.ListAssignedLocations.", + "id": "ListAssignedLocationsResponse", + "properties": { + "assignedLocations": { + "description": "The list of assigned locations.\n\nThis list will be absent if empty.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.\n\nPass this value in the\npage_token field\nin the subsequent call to `ListAssignedLocations` method to\nretrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, "ListCampaignsResponse": { "id": "ListCampaignsResponse", "properties": { @@ -8270,6 +9845,42 @@ }, "type": "object" }, + "ListNegativeKeywordsResponse": { + "description": "Response message for NegativeKeywordService.ListNegativeKeywords.", + "id": "ListNegativeKeywordsResponse", + "properties": { + "negativeKeywords": { + "description": "The list of negative keywords.\n\nThis list will be absent if empty.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.\n\nPass this value in the page_token\nfield in the subsequent call to `ListNegativeKeywords` method to retrieve\nthe next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListSitesResponse": { + "description": "Response message for SiteService.ListSites.", + "id": "ListSitesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results.\n\nPass this value in the page_token field\nin the subsequent call to `ListSites` method to retrieve the next page\nof results.", + "type": "string" + }, + "sites": { + "description": "The list of sites.\n\nThis list will be absent if empty.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, "ListTargetingOptionsResponse": { "description": "Response message for\nListTargetingOptions.", "id": "ListTargetingOptionsResponse", @@ -8399,6 +10010,21 @@ }, "type": "object" }, + "NegativeKeyword": { + "description": "A negatively targeted keyword that belongs to a negative keyword list.", + "id": "NegativeKeyword", + "properties": { + "keywordValue": { + "description": "Required. Immutable. The negatively targeted keyword, for example `car insurance`.\n\nMust be UTF-8 encoded with a maximum size of 255 bytes. Maximum number\nof characters is 80. Maximum number of words is 10.\n\nValid characters are restricted to ASCII characters only. The only\nURL-escaping permitted is for representing whitespace between words.\nLeading or trailing whitespace is ignored.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the negative keyword.", + "type": "string" + } + }, + "type": "object" + }, "NegativeKeywordList": { "description": "A list of negative keywords used for targeting.", "id": "NegativeKeywordList", @@ -9357,6 +10983,21 @@ }, "type": "object" }, + "Site": { + "description": "A single site. Sites are apps or websites belonging to a channel.", + "id": "Site", + "properties": { + "name": { + "description": "Output only. The resource name of the site.", + "type": "string" + }, + "urlOrAppId": { + "description": "Required. The URL or app ID of the site.\nMust be UTF-8 encoded with a maximum length of 240 bytes.", + "type": "string" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", diff --git a/src/apis/displayvideo/v1.ts b/src/apis/displayvideo/v1.ts index b3ffe90823..9513783b52 100644 --- a/src/apis/displayvideo/v1.ts +++ b/src/apis/displayvideo/v1.ts @@ -413,6 +413,40 @@ export namespace displayvideo_v1 { */ role?: string | null; } + /** + * An assignment between a targetable inventory source and an inventory source group. + */ + export interface Schema$AssignedInventorySource { + /** + * Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts. + */ + assignedInventorySourceId?: string | null; + /** + * Required. The ID of the inventory source entity being targeted. + */ + inventorySourceId?: string | null; + /** + * Output only. The resource name of the assigned inventory source. + */ + name?: string | null; + } + /** + * An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment. + */ + export interface Schema$AssignedLocation { + /** + * Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts. + */ + assignedLocationId?: string | null; + /** + * Output only. The resource name of the assigned location. + */ + name?: string | null; + /** + * Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION. + */ + targetingOptionId?: string | null; + } /** * A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings, such as a Line Item or Insertion Order. */ @@ -708,6 +742,58 @@ export namespace displayvideo_v1 { */ createdAssignedTargetingOptions?: Schema$AssignedTargetingOption[]; } + /** + * Request message for AssignedInventorySourceService.BulkEdit. + */ + export interface Schema$BulkEditAssignedInventorySourcesRequest { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources. + */ + advertiserId?: string | null; + /** + * The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources. + */ + createdAssignedInventorySources?: Schema$AssignedInventorySource[]; + /** + * The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids. + */ + deletedAssignedInventorySources?: string[] | null; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources. + */ + partnerId?: string | null; + } + /** + * Response message for AssignedInventorySourceService.BulkEdit. + */ + export interface Schema$BulkEditAssignedInventorySourcesResponse { + /** + * The list of assigned inventory sources that have been successfully created. This list will be absent if empty. + */ + assignedInventorySources?: Schema$AssignedInventorySource[]; + } + /** + * Request message for AssignedLocationService.BulkEditAssignedLocations. + */ + export interface Schema$BulkEditAssignedLocationsRequest { + /** + * The assigned locations to create in bulk, specified as a list of AssignedLocations. + */ + createdAssignedLocations?: Schema$AssignedLocation[]; + /** + * The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids. + */ + deletedAssignedLocations?: string[] | null; + } + /** + * Response message for AssignedLocationService.BulkEditAssignedLocations. + */ + export interface Schema$BulkEditAssignedLocationsResponse { + /** + * The list of assigned locations that have been successfully created. This list will be absent if empty. + */ + assignedLocations?: Schema$AssignedLocation[]; + } /** * Request message for BulkEditLineItemAssignedTargetingOptions. */ @@ -727,6 +813,58 @@ export namespace displayvideo_v1 { */ createdAssignedTargetingOptions?: Schema$AssignedTargetingOption[]; } + /** + * Request message for NegativeKeywordService.BulkEditNegativeKeywords. + */ + export interface Schema$BulkEditNegativeKeywordsRequest { + /** + * The negative keywords to create in batch, specified as a list of NegativeKeywords. + */ + createdNegativeKeywords?: Schema$NegativeKeyword[]; + /** + * The negative keywords to delete in batch, specified as a list of keyword_values. + */ + deletedNegativeKeywords?: string[] | null; + } + /** + * Response message for NegativeKeywordService.BulkEditNegativeKeywords. + */ + export interface Schema$BulkEditNegativeKeywordsResponse { + /** + * The list of negative keywords that have been successfully created. This list will be absent if empty. + */ + negativeKeywords?: Schema$NegativeKeyword[]; + } + /** + * Request message for SiteService.BulkEditSites. + */ + export interface Schema$BulkEditSitesRequest { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string | null; + /** + * The sites to create in batch, specified as a list of Sites. + */ + createdSites?: Schema$Site[]; + /** + * The sites to delete in batch, specified as a list of site url_or_app_ids. + */ + deletedSites?: string[] | null; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string | null; + } + /** + * Response message for SiteService.BulkEditSites. + */ + export interface Schema$BulkEditSitesResponse { + /** + * The list of sites that have been successfully created. This list will be absent if empty. + */ + sites?: Schema$Site[]; + } export interface Schema$BulkListAdvertiserAssignedTargetingOptionsResponse { /** * The list of assigned targeting options. This list will be absent if empty. @@ -2438,6 +2576,32 @@ export namespace displayvideo_v1 { */ nextPageToken?: string | null; } + /** + * Response message for AssignedInventorySourceService.ListAssignedInventorySources. + */ + export interface Schema$ListAssignedInventorySourcesResponse { + /** + * The list of assigned inventory sources. This list will be absent if empty. + */ + assignedInventorySources?: Schema$AssignedInventorySource[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedInventorySources` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for AssignedLocationService.ListAssignedLocations. + */ + export interface Schema$ListAssignedLocationsResponse { + /** + * The list of assigned locations. This list will be absent if empty. + */ + assignedLocations?: Schema$AssignedLocation[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedLocations` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } export interface Schema$ListCampaignsResponse { /** * The list of campaigns. This list will be absent if empty. @@ -2587,6 +2751,32 @@ export namespace displayvideo_v1 { */ nextPageToken?: string | null; } + /** + * Response message for NegativeKeywordService.ListNegativeKeywords. + */ + export interface Schema$ListNegativeKeywordsResponse { + /** + * The list of negative keywords. This list will be absent if empty. + */ + negativeKeywords?: Schema$NegativeKeyword[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywords` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for SiteService.ListSites. + */ + export interface Schema$ListSitesResponse { + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of sites. This list will be absent if empty. + */ + sites?: Schema$Site[]; + } /** * Response message for ListTargetingOptions. */ @@ -2668,6 +2858,19 @@ export namespace displayvideo_v1 { */ units?: string | null; } + /** + * A negatively targeted keyword that belongs to a negative keyword list. + */ + export interface Schema$NegativeKeyword { + /** + * Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. + */ + keywordValue?: string | null; + /** + * Output only. The resource name of the negative keyword. + */ + name?: string | null; + } /** * A list of negative keywords used for targeting. */ @@ -3090,6 +3293,19 @@ export namespace displayvideo_v1 { */ sensitiveCategory?: string | null; } + /** + * A single site. Sites are apps or websites belonging to a channel. + */ + export interface Schema$Site { + /** + * Output only. The resource name of the site. + */ + name?: string | null; + /** + * Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. + */ + urlOrAppId?: string | null; + } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -5758,8 +5974,10 @@ export namespace displayvideo_v1 { export class Resource$Advertisers$Channels { context: APIRequestContext; + sites: Resource$Advertisers$Channels$Sites; constructor(context: APIRequestContext) { this.context = context; + this.sites = new Resource$Advertisers$Channels$Sites(this.context); } /** @@ -6083,60 +6301,10 @@ export namespace displayvideo_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Channels$Get - extends StandardParameters { - /** - * The ID of the advertiser that owns the fetched channel. - */ - advertiserId?: string; - /** - * Required. The ID of the channel to fetch. - */ - channelId?: string; - /** - * The ID of the partner that owns the fetched channel. - */ - partnerId?: string; - } - export interface Params$Resource$Advertisers$Channels$List - extends StandardParameters { - /** - * The ID of the advertiser that owns the channels. - */ - advertiserId?: string; - /** - * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * The ID of the partner that owns the channels. - */ - partnerId?: string; - } - - export class Resource$Advertisers$Creatives { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * displayvideo.advertisers.creatives.create - * @desc Creates a new creative. Returns the newly created creative if successful. + * displayvideo.advertisers.channels.patch + * @desc Updates a channel. Returns the updated channel if successful. * @example * // Before running the sample: * // - Enable the API at: @@ -6160,59 +6328,25 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.create({ - * // Output only. The unique ID of the advertiser the creative belongs to. + * const res = await displayvideo.advertisers.channels.patch({ + * // The ID of the advertiser that owns the created channel. * advertiserId: '[^/]+', + * // Output only. The unique ID of the channel. Assigned by the system. + * channelId: 'placeholder-value', + * // The ID of the partner that owns the created channel. + * partnerId: 'placeholder-value', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "additionalDimensions": [], * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, + * // "channelId": "my_channelId", * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false + * // "partnerId": "my_partnerId" * // } * }, * }); @@ -6220,51 +6354,11 @@ export namespace displayvideo_v1 { * * // Example response * // { - * // "additionalDimensions": [], * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, + * // "channelId": "my_channelId", * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false + * // "partnerId": "my_partnerId" * // } * } * @@ -6273,60 +6367,63 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.creatives.create + * @alias displayvideo.advertisers.channels.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Output only. The unique ID of the advertiser the creative belongs to. - * @param {().Creative} params.requestBody Request body data + * @param {string} params.advertiserId The ID of the advertiser that owns the created channel. + * @param {string} params.channelId Output only. The unique ID of the channel. Assigned by the system. + * @param {string=} params.partnerId The ID of the partner that owns the created channel. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().Channel} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params: Params$Resource$Advertisers$Creatives$Create, + patch( + params: Params$Resource$Advertisers$Channels$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Advertisers$Creatives$Create, + patch( + params?: Params$Resource$Advertisers$Channels$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Advertisers$Creatives$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Channels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Creatives$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Channels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Creatives$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Channels$Patch, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$Create; + {}) as Params$Resource$Advertisers$Channels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$Create; + params = {} as Params$Resource$Advertisers$Channels$Patch; options = {}; } @@ -6340,30 +6437,104 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/advertisers/{+advertiserId}/creatives' + rootUrl + '/v1/advertisers/{+advertiserId}/channels/{channelId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Channels$Get + extends StandardParameters { /** - * displayvideo.advertisers.creatives.delete - * @desc Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. + * The ID of the advertiser that owns the fetched channel. + */ + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + + export class Resource$Advertisers$Channels$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.channels.sites.bulkEdit + * @desc Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. * @example * // Before running the sample: * // - Enable the API at: @@ -6387,16 +6558,29 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.delete({ - * // The ID of the advertiser this creative belongs to. - * advertiserId: '[^/]+', - * // The ID of the creative to be deleted. - * creativeId: '[^/]+', + * const res = await displayvideo.advertisers.channels.sites.bulkEdit({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel to which the sites belong. + * channelId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "createdSites": [], + * // "deletedSites": [], + * // "partnerId": "my_partnerId" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "sites": [] + * // } * } * * main().catch(e => { @@ -6404,60 +6588,68 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.creatives.delete + * @alias displayvideo.advertisers.channels.sites.bulkEdit * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId The ID of the advertiser this creative belongs to. - * @param {string} params.creativeId The ID of the creative to be deleted. + * @param {string} params.advertiserId The ID of the advertiser that owns the parent channel. + * @param {string} params.channelId Required. The ID of the parent channel to which the sites belong. + * @param {().BulkEditSitesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params: Params$Resource$Advertisers$Creatives$Delete, + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Advertisers$Creatives$Delete, + bulkEdit( + params?: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Advertisers$Creatives$Delete, + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Creatives$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Creatives$Delete, - callback: BodyResponseCallback + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Bulkedit + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$Delete; + {}) as Params$Resource$Advertisers$Channels$Sites$Bulkedit; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$Delete; + params = {} as Params$Resource$Advertisers$Channels$Sites$Bulkedit; options = {}; } @@ -6472,30 +6664,30 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' + '/v1/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', }, options ), params, - requiredParams: ['advertiserId', 'creativeId'], - pathParams: ['advertiserId', 'creativeId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.creatives.get - * @desc Gets a creative. + * displayvideo.advertisers.channels.sites.create + * @desc Creates a site in a channel. * @example * // Before running the sample: * // - Enable the API at: @@ -6519,61 +6711,29 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.get({ - * // Required. The ID of the advertiser this creative belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the creative to fetch. - * creativeId: '[^/]+', + * const res = await displayvideo.advertisers.channels.sites.create({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel in which the site will be created. + * channelId: '[^/]+', + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "name": "my_name", + * // "urlOrAppId": "my_urlOrAppId" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false + * // "urlOrAppId": "my_urlOrAppId" * // } * } * @@ -6582,60 +6742,62 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.creatives.get + * @alias displayvideo.advertisers.channels.sites.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser this creative belongs to. - * @param {string} params.creativeId Required. The ID of the creative to fetch. + * @param {string} params.advertiserId The ID of the advertiser that owns the parent channel. + * @param {string} params.channelId Required. The ID of the parent channel in which the site will be created. + * @param {string=} params.partnerId The ID of the partner that owns the parent channel. + * @param {().Site} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Advertisers$Creatives$Get, + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Advertisers$Creatives$Get, + create( + params?: Params$Resource$Advertisers$Channels$Sites$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertisers$Creatives$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Creatives$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Creatives$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$Get; + {}) as Params$Resource$Advertisers$Channels$Sites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$Get; + params = {} as Params$Resource$Advertisers$Channels$Sites$Create; options = {}; } @@ -6650,30 +6812,30 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' + '/v1/advertisers/{advertiserId}/channels/{+channelId}/sites' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['advertiserId', 'creativeId'], - pathParams: ['advertiserId', 'creativeId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.creatives.list - * @desc Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * displayvideo.advertisers.channels.sites.delete + * @desc Deletes a site from a channel. * @example * // Before running the sample: * // - Enable the API at: @@ -6697,85 +6859,194 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.list({ - * // Required. The ID of the advertiser to list creatives for. + * const res = await displayvideo.advertisers.channels.sites.delete({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel to which the site belongs. + * channelId: '[^/]+', + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', + * // Required. The URL or app ID of the site to delete. + * urlOrAppId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.channels.sites.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser that owns the parent channel. + * @param {string} params.channelId Required. The ID of the parent channel to which the site belongs. + * @param {string=} params.partnerId The ID of the partner that owns the parent channel. + * @param {string} params.urlOrAppId Required. The URL or app ID of the site to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Channels$Sites$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId', 'urlOrAppId'], + pathParams: ['advertiserId', 'channelId', 'urlOrAppId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.channels.sites.list + * @desc Lists sites in a channel. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.channels.sites.list({ + * // The ID of the advertiser that owns the parent channel. * advertiserId: '[^/]+', - * // Allows filtering by creative properties. + * // Required. The ID of the parent channel to which the requested sites belong. + * channelId: '[^/]+', + * // Allows filtering by site fields. * // * // Supported syntax: * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restriction for the same field must be combined by `OR`. - * // * Restriction for different fields must be combined by `AND`. - * // * Between `(` and `)` there can only be restrictions combined by `OR` - * // for the same field. + * // * Filter expressions for site currently can only contain at most one + * // * restriction. * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)` for the following fields: - * // - `entityStatus` - * // - `creativeType`. - * // - `dimensions` - * // - `minDuration` - * // - `maxDuration` - * // - `approvalStatus` - * // - `exchangeReviewStatus` - * // - `dynamic` - * // * The operator must be `HAS (:)` for the following fields: - * // - `lineItemIds` - * // * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may - * // be at most one restriction. - * // * For `dimensions`, the value is in the form of `"{width}x{height}"`. - * // * For `exchangeReviewStatus`, the value is in the form of - * // `{exchange}-{reviewStatus}`. - * // * For `minDuration` and `maxDuration`, the value is in the form of - * // `"{duration}s"`. Only seconds are supported with millisecond granularity. - * // * There may be multiple `lineItemIds` restrictions in order to search - * // against multiple possible line item IDs. + * // * The operator must be `CONTAINS (:)`. + * // * Supported fields: + * // - `urlOrAppId` * // * // Examples: * // - * // * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` - * // * All active creatives with 300x400 or 50x100 dimensions: - * // `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" - * // OR dimensions="50x100")` - * // * All dynamic creatives that are approved by AdX or - * // AppNexus, with a minimum duration of 5 seconds and 200ms. - * // `dynamic="true" AND minDuration="5.2s" AND - * // (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" - * // OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` - * // * All video creatives that are associated with line item ID 1 or 2: - * // creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) - * // - * // The length of this field should be no more than 500 characters. + * // * All sites for which the URL or app ID contains "google": + * // `urlOrAppId : "google"` * filter: 'placeholder-value', * // Field by which to sort the list. * // Acceptable values are: * // - * // * `creativeId` (default) - * // * `createTime` - * // * `mediaDuration` - * // * `dimensions` (sorts by width first, then by height) + * // * `urlOrAppId` (default) * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. - * // Example: `createTime desc`. + * // The default sorting order is ascending. To specify descending order for a + * // field, a suffix " desc" should be added to the field name. Example: + * // `urlOrAppId desc`. * orderBy: 'placeholder-value', * // Requested page size. Must be between `1` and `100`. If unspecified will * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value * // is specified. * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. + * // * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListCreatives` method. - * // If not specified, the first page of results will be returned. + * // next_page_token returned from the + * // previous call to `ListSites` method. If not specified, the first page + * // of results will be returned. * pageToken: 'placeholder-value', + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "creatives": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "sites": [] * // } * } * @@ -6784,68 +7055,68 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.creatives.list + * @alias displayvideo.advertisers.channels.sites.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser to list creatives for. - * @param {string=} params.filter Allows filtering by creative properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)` for the following fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` * The operator must be `HAS (:)` for the following fields: - `lineItemIds` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may be at most one restriction. * For `dimensions`, the value is in the form of `"{width}x{height}"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `"{duration}s"`. Only seconds are supported with millisecond granularity. * There may be multiple `lineItemIds` restrictions in order to search against multiple possible line item IDs. Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. + * @param {string} params.advertiserId The ID of the advertiser that owns the parent channel. + * @param {string} params.channelId Required. The ID of the parent channel to which the requested sites belong. + * @param {string=} params.filter Allows filtering by site fields. Supported syntax: * Filter expressions for site currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that owns the parent channel. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params: Params$Resource$Advertisers$Creatives$List, + params: Params$Resource$Advertisers$Channels$Sites$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Advertisers$Creatives$List, + params?: Params$Resource$Advertisers$Channels$Sites$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Advertisers$Creatives$List, + params: Params$Resource$Advertisers$Channels$Sites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Creatives$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Channels$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Creatives$List, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Channels$Sites$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$List - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$List; + {}) as Params$Resource$Advertisers$Channels$Sites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$List; + params = {} as Params$Resource$Advertisers$Channels$Sites$List; options = {}; } @@ -6859,30 +7130,125 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/advertisers/{+advertiserId}/creatives' + rootUrl + + '/v1/advertisers/{+advertiserId}/channels/{+channelId}/sites' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Channels$Sites$Bulkedit + extends StandardParameters { /** - * displayvideo.advertisers.creatives.patch - * @desc Updates an existing creative. Returns the updated creative if successful. + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the sites belong. + */ + channelId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditSitesRequest; + } + export interface Params$Resource$Advertisers$Channels$Sites$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel in which the site will be created. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Advertisers$Channels$Sites$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the site belongs. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + /** + * Required. The URL or app ID of the site to delete. + */ + urlOrAppId?: string; + } + export interface Params$Resource$Advertisers$Channels$Sites$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the requested sites belong. + */ + channelId?: string; + /** + * Allows filtering by site fields. Supported syntax: * Filter expressions for site currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + } + + export class Resource$Advertisers$Creatives { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.creatives.create + * @desc Creates a new creative. Returns the newly created creative if successful. * @example * // Before running the sample: * // - Enable the API at: @@ -6906,13 +7272,9 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.patch({ + * const res = await displayvideo.advertisers.creatives.create({ * // Output only. The unique ID of the advertiser the creative belongs to. * advertiserId: '[^/]+', - * // Output only. The unique ID of the creative. Assigned by the system. - * creativeId: '[^/]+', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -7023,44 +7385,42 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.creatives.patch + * @alias displayvideo.advertisers.creatives.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.advertiserId Output only. The unique ID of the advertiser the creative belongs to. - * @param {string} params.creativeId Output only. The unique ID of the creative. Assigned by the system. - * @param {string=} params.updateMask Required. The mask to control which fields to update. * @param {().Creative} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - patch( - params: Params$Resource$Advertisers$Creatives$Patch, + create( + params: Params$Resource$Advertisers$Creatives$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Advertisers$Creatives$Patch, + create( + params?: Params$Resource$Advertisers$Creatives$Create, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Advertisers$Creatives$Patch, + create( + params: Params$Resource$Advertisers$Creatives$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Creatives$Patch, + create( + params: Params$Resource$Advertisers$Creatives$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Creatives$Patch, + create( + params: Params$Resource$Advertisers$Creatives$Create, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$Patch + | Params$Resource$Advertisers$Creatives$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7073,12 +7433,12 @@ export namespace displayvideo_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$Patch; + {}) as Params$Resource$Advertisers$Creatives$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$Patch; + params = {} as Params$Resource$Advertisers$Creatives$Create; options = {}; } @@ -7092,16 +7452,15 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' + rootUrl + '/v1/advertisers/{+advertiserId}/creatives' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', }, options ), params, - requiredParams: ['advertiserId', 'creativeId'], - pathParams: ['advertiserId', 'creativeId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { @@ -7113,95 +7472,10 @@ export namespace displayvideo_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Creatives$Create - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the creative belongs to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - export interface Params$Resource$Advertisers$Creatives$Delete - extends StandardParameters { - /** - * The ID of the advertiser this creative belongs to. - */ - advertiserId?: string; - /** - * The ID of the creative to be deleted. - */ - creativeId?: string; - } - export interface Params$Resource$Advertisers$Creatives$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser this creative belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the creative to fetch. - */ - creativeId?: string; - } - export interface Params$Resource$Advertisers$Creatives$List - extends StandardParameters { - /** - * Required. The ID of the advertiser to list creatives for. - */ - advertiserId?: string; - /** - * Allows filtering by creative properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)` for the following fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` * The operator must be `HAS (:)` for the following fields: - `lineItemIds` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may be at most one restriction. * For `dimensions`, the value is in the form of `"{width}x{height}"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `"{duration}s"`. Only seconds are supported with millisecond granularity. * There may be multiple `lineItemIds` restrictions in order to search against multiple possible line item IDs. Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Creatives$Patch - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the creative belongs to. - */ - advertiserId?: string; - /** - * Output only. The unique ID of the creative. Assigned by the system. - */ - creativeId?: string; - /** - * Required. The mask to control which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - - export class Resource$Advertisers$Insertionorders { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * displayvideo.advertisers.insertionOrders.create - * @desc Creates a new insertion order. Returns the newly created insertion order if successful. + * displayvideo.advertisers.creatives.delete + * @desc Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. * @example * // Before running the sample: * // - Enable the API at: @@ -7225,50 +7499,16 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.create({ - * // Output only. The unique ID of the advertiser the insertion order belongs to. + * const res = await displayvideo.advertisers.creatives.delete({ + * // The ID of the advertiser this creative belongs to. * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "performanceGoal": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * // The ID of the creative to be deleted. + * creativeId: '[^/]+', * }); * console.log(res.data); * * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "performanceGoal": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -7276,60 +7516,60 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.insertionOrders.create + * @alias displayvideo.advertisers.creatives.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Output only. The unique ID of the advertiser the insertion order belongs to. - * @param {().InsertionOrder} params.requestBody Request body data + * @param {string} params.advertiserId The ID of the advertiser this creative belongs to. + * @param {string} params.creativeId The ID of the creative to be deleted. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params: Params$Resource$Advertisers$Insertionorders$Create, + delete( + params: Params$Resource$Advertisers$Creatives$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Advertisers$Insertionorders$Create, + delete( + params?: Params$Resource$Advertisers$Creatives$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Advertisers$Insertionorders$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Insertionorders$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Insertionorders$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Create; + {}) as Params$Resource$Advertisers$Creatives$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Create; + params = {} as Params$Resource$Advertisers$Creatives$Delete; options = {}; } @@ -7343,30 +7583,31 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/advertisers/{+advertiserId}/insertionOrders' + rootUrl + + '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.insertionOrders.delete - * @desc Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. + * displayvideo.advertisers.creatives.get + * @desc Gets a creative. * @example * // Before running the sample: * // - Enable the API at: @@ -7390,16 +7631,62 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.delete({ - * // The ID of the advertiser this insertion order belongs to. + * const res = await displayvideo.advertisers.creatives.get({ + * // Required. The ID of the advertiser this creative belongs to. * advertiserId: '[^/]+', - * // The ID of the insertion order we need to delete. - * insertionOrderId: '[^/]+', + * // Required. The ID of the creative to fetch. + * creativeId: '[^/]+', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "additionalDimensions": [], + * // "advertiserId": "my_advertiserId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, + * // "displayName": "my_displayName", + * // "dynamic": false, + * // "entityStatus": "my_entityStatus", + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "name": "my_name", + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false + * // } * } * * main().catch(e => { @@ -7407,60 +7694,60 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.insertionOrders.delete + * @alias displayvideo.advertisers.creatives.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId The ID of the advertiser this insertion order belongs to. - * @param {string} params.insertionOrderId The ID of the insertion order we need to delete. + * @param {string} params.advertiserId Required. The ID of the advertiser this creative belongs to. + * @param {string} params.creativeId Required. The ID of the creative to fetch. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, + get( + params: Params$Resource$Advertisers$Creatives$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Advertisers$Insertionorders$Delete, + get( + params?: Params$Resource$Advertisers$Creatives$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Creatives$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Creatives$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Creatives$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Delete; + {}) as Params$Resource$Advertisers$Creatives$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Delete; + params = {} as Params$Resource$Advertisers$Creatives$Get; options = {}; } @@ -7475,30 +7762,30 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.insertionOrders.get - * @desc Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. + * displayvideo.advertisers.creatives.list + * @desc Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results. * @example * // Before running the sample: * // - Enable the API at: @@ -7522,188 +7809,67 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.get({ - * // Required. The ID of the advertiser this insertion order belongs to. + * const res = await displayvideo.advertisers.creatives.list({ + * // Required. The ID of the advertiser to list creatives for. * advertiserId: '[^/]+', - * // Required. The ID of the insertion order to fetch. - * insertionOrderId: '[^/]+', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "performanceGoal": {}, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias displayvideo.advertisers.insertionOrders.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser this insertion order belongs to. - * @param {string} params.insertionOrderId Required. The ID of the insertion order to fetch. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params: Params$Resource$Advertisers$Insertionorders$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Advertisers$Insertionorders$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertisers$Insertionorders$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertisers$Insertionorders$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertisers$Insertionorders$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback<{} | void> - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * displayvideo.advertisers.insertionOrders.list - * @desc Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.list({ - * // Required. The ID of the advertiser to list insertion orders for. - * advertiserId: '[^/]+', - * // Allows filtering by insertion order properties. + * // Allows filtering by creative properties. * // * // Supported syntax: * // * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by `AND` or `OR` logical operators. A - * // sequence of restrictions implicitly uses `AND`. + * // * Restriction for the same field must be combined by `OR`. + * // * Restriction for different fields must be combined by `AND`. + * // * Between `(` and `)` there can only be restrictions combined by `OR` + * // for the same field. * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)`. - * // * Supported fields: - * // - `campaignId` + * // * The operator must be `EQUALS (=)` for the following fields: * // - `entityStatus` + * // - `creativeType`. + * // - `dimensions` + * // - `minDuration` + * // - `maxDuration` + * // - `approvalStatus` + * // - `exchangeReviewStatus` + * // - `dynamic` + * // * The operator must be `HAS (:)` for the following fields: + * // - `lineItemIds` + * // * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may + * // be at most one restriction. + * // * For `dimensions`, the value is in the form of `"{width}x{height}"`. + * // * For `exchangeReviewStatus`, the value is in the form of + * // `{exchange}-{reviewStatus}`. + * // * For `minDuration` and `maxDuration`, the value is in the form of + * // `"{duration}s"`. Only seconds are supported with millisecond granularity. + * // * There may be multiple `lineItemIds` restrictions in order to search + * // against multiple possible line item IDs. * // * // Examples: * // - * // * All insertion orders under a campaign: `campaignId="1234"` - * // * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders - * // under an advertiser: - * // `(entityStatus="ENTITY_STATUS_ACTIVE" OR - * // entityStatus="ENTITY_STATUS_PAUSED")` + * // * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` + * // * All active creatives with 300x400 or 50x100 dimensions: + * // `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" + * // OR dimensions="50x100")` + * // * All dynamic creatives that are approved by AdX or + * // AppNexus, with a minimum duration of 5 seconds and 200ms. + * // `dynamic="true" AND minDuration="5.2s" AND + * // (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" + * // OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` + * // * All video creatives that are associated with line item ID 1 or 2: + * // creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) * // * // The length of this field should be no more than 500 characters. * filter: 'placeholder-value', * // Field by which to sort the list. * // Acceptable values are: * // - * // * "displayName" (default) - * // * "entityStatus" + * // * `creativeId` (default) + * // * `createTime` + * // * `mediaDuration` + * // * `dimensions` (sorts by width first, then by height) * // * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `displayName desc`. + * // a field, a suffix "desc" should be added to the field name. + * // Example: `createTime desc`. * orderBy: 'placeholder-value', * // Requested page size. Must be between `1` and `100`. If unspecified will * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value @@ -7711,16 +7877,16 @@ export namespace displayvideo_v1 { * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. * // Typically, this is the value of - * // next_page_token returned - * // from the previous call to `ListInsertionOrders` method. If not specified, - * // the first page of results will be returned. + * // next_page_token + * // returned from the previous call to `ListCreatives` method. + * // If not specified, the first page of results will be returned. * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "insertionOrders": [], + * // "creatives": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -7730,70 +7896,68 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.insertionOrders.list + * @alias displayvideo.advertisers.creatives.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser to list insertion orders for. - * @param {string=} params.filter Allows filtering by insertion order properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `entityStatus` Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {string} params.advertiserId Required. The ID of the advertiser to list creatives for. + * @param {string=} params.filter Allows filtering by creative properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)` for the following fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` * The operator must be `HAS (:)` for the following fields: - `lineItemIds` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may be at most one restriction. * For `dimensions`, the value is in the form of `"{width}x{height}"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `"{duration}s"`. Only seconds are supported with millisecond granularity. * There may be multiple `lineItemIds` restrictions in order to search against multiple possible line item IDs. Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params: Params$Resource$Advertisers$Insertionorders$List, + params: Params$Resource$Advertisers$Creatives$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Advertisers$Insertionorders$List, + params?: Params$Resource$Advertisers$Creatives$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Advertisers$Insertionorders$List, + params: Params$Resource$Advertisers$Creatives$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Insertionorders$List, + params: Params$Resource$Advertisers$Creatives$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$Insertionorders$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Creatives$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$List - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$List; + {}) as Params$Resource$Advertisers$Creatives$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$List; + params = {} as Params$Resource$Advertisers$Creatives$List; options = {}; } @@ -7807,7 +7971,7 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/advertisers/{+advertiserId}/insertionOrders' + rootUrl + '/v1/advertisers/{+advertiserId}/creatives' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -7819,18 +7983,18 @@ export namespace displayvideo_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.insertionOrders.patch - * @desc Updates an existing insertion order. Returns the updated insertion order if successful. + * displayvideo.advertisers.creatives.patch + * @desc Updates an existing creative. Returns the updated creative if successful. * @example * // Before running the sample: * // - Enable the API at: @@ -7854,11 +8018,11 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.patch({ - * // Output only. The unique ID of the advertiser the insertion order belongs to. + * const res = await displayvideo.advertisers.creatives.patch({ + * // Output only. The unique ID of the advertiser the creative belongs to. * advertiserId: '[^/]+', - * // Output only. The unique ID of the insertion order. Assigned by the system. - * insertionOrderId: '[^/]+', + * // Output only. The unique ID of the creative. Assigned by the system. + * creativeId: '[^/]+', * // Required. The mask to control which fields to update. * updateMask: 'placeholder-value', * @@ -7866,41 +8030,103 @@ export namespace displayvideo_v1 { * requestBody: { * // request body parameters * // { + * // "additionalDimensions": [], * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, * // "displayName": "my_displayName", + * // "dynamic": false, * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "performanceGoal": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { + * // "additionalDimensions": [], * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, * // "displayName": "my_displayName", + * // "dynamic": false, * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "performanceGoal": {}, - * // "updateTime": "my_updateTime" + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false * // } * } * @@ -7909,62 +8135,62 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.insertionOrders.patch + * @alias displayvideo.advertisers.creatives.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Output only. The unique ID of the advertiser the insertion order belongs to. - * @param {string} params.insertionOrderId Output only. The unique ID of the insertion order. Assigned by the system. + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the creative belongs to. + * @param {string} params.creativeId Output only. The unique ID of the creative. Assigned by the system. * @param {string=} params.updateMask Required. The mask to control which fields to update. - * @param {().InsertionOrder} params.requestBody Request body data + * @param {().Creative} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, + params: Params$Resource$Advertisers$Creatives$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Advertisers$Insertionorders$Patch, + params?: Params$Resource$Advertisers$Creatives$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, + params: Params$Resource$Advertisers$Creatives$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Creatives$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Creatives$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Patch - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Patch; + {}) as Params$Resource$Advertisers$Creatives$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Patch; + params = {} as Params$Resource$Advertisers$Creatives$Patch; options = {}; } @@ -7979,74 +8205,74 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Advertisers$Insertionorders$Create + export interface Params$Resource$Advertisers$Creatives$Create extends StandardParameters { /** - * Output only. The unique ID of the advertiser the insertion order belongs to. + * Output only. The unique ID of the advertiser the creative belongs to. */ advertiserId?: string; /** * Request body metadata */ - requestBody?: Schema$InsertionOrder; + requestBody?: Schema$Creative; } - export interface Params$Resource$Advertisers$Insertionorders$Delete + export interface Params$Resource$Advertisers$Creatives$Delete extends StandardParameters { /** - * The ID of the advertiser this insertion order belongs to. + * The ID of the advertiser this creative belongs to. */ advertiserId?: string; /** - * The ID of the insertion order we need to delete. + * The ID of the creative to be deleted. */ - insertionOrderId?: string; + creativeId?: string; } - export interface Params$Resource$Advertisers$Insertionorders$Get + export interface Params$Resource$Advertisers$Creatives$Get extends StandardParameters { /** - * Required. The ID of the advertiser this insertion order belongs to. + * Required. The ID of the advertiser this creative belongs to. */ advertiserId?: string; /** - * Required. The ID of the insertion order to fetch. + * Required. The ID of the creative to fetch. */ - insertionOrderId?: string; + creativeId?: string; } - export interface Params$Resource$Advertisers$Insertionorders$List + export interface Params$Resource$Advertisers$Creatives$List extends StandardParameters { /** - * Required. The ID of the advertiser to list insertion orders for. + * Required. The ID of the advertiser to list creatives for. */ advertiserId?: string; /** - * Allows filtering by insertion order properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `entityStatus` Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no more than 500 characters. + * Allows filtering by creative properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)` for the following fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` * The operator must be `HAS (:)` for the following fields: - `lineItemIds` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may be at most one restriction. * For `dimensions`, the value is in the form of `"{width}x{height}"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `"{duration}s"`. Only seconds are supported with millisecond granularity. * There may be multiple `lineItemIds` restrictions in order to search against multiple possible line item IDs. Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) The length of this field should be no more than 500 characters. */ filter?: string; /** - * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. */ orderBy?: string; /** @@ -8054,20 +8280,20 @@ export namespace displayvideo_v1 { */ pageSize?: number; /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. */ pageToken?: string; } - export interface Params$Resource$Advertisers$Insertionorders$Patch + export interface Params$Resource$Advertisers$Creatives$Patch extends StandardParameters { /** - * Output only. The unique ID of the advertiser the insertion order belongs to. + * Output only. The unique ID of the advertiser the creative belongs to. */ advertiserId?: string; /** - * Output only. The unique ID of the insertion order. Assigned by the system. + * Output only. The unique ID of the creative. Assigned by the system. */ - insertionOrderId?: string; + creativeId?: string; /** * Required. The mask to control which fields to update. */ @@ -8076,22 +8302,18 @@ export namespace displayvideo_v1 { /** * Request body metadata */ - requestBody?: Schema$InsertionOrder; + requestBody?: Schema$Creative; } - export class Resource$Advertisers$Lineitems { + export class Resource$Advertisers$Insertionorders { context: APIRequestContext; - targetingTypes: Resource$Advertisers$Lineitems$Targetingtypes; constructor(context: APIRequestContext) { this.context = context; - this.targetingTypes = new Resource$Advertisers$Lineitems$Targetingtypes( - this.context - ); } /** - * displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions - * @desc Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests . + * displayvideo.advertisers.insertionOrders.create + * @desc Creates a new insertion order. Returns the newly created insertion order if successful. * @example * // Before running the sample: * // - Enable the API at: @@ -8115,28 +8337,49 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions( - * { - * // Required. The ID of the advertiser the line item belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the line item the assigned targeting option will belong to. - * lineItemId: '[^/]+', + * const res = await displayvideo.advertisers.insertionOrders.create({ + * // Output only. The unique ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createRequests": [], - * // "deleteRequests": [] - * // } - * }, - * } - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "performanceGoal": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createdAssignedTargetingOptions": [] + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "performanceGoal": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -8145,82 +8388,60 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions + * @alias displayvideo.advertisers.insertionOrders.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. - * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option will belong to. - * @param {().BulkEditLineItemAssignedTargetingOptionsRequest} params.requestBody Request body data + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the insertion order belongs to. + * @param {().InsertionOrder} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - bulkEditLineItemAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, + create( + params: Params$Resource$Advertisers$Insertionorders$Create, options: StreamMethodOptions ): GaxiosPromise; - bulkEditLineItemAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, + create( + params?: Params$Resource$Advertisers$Insertionorders$Create, options?: MethodOptions - ): GaxiosPromise; - bulkEditLineItemAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkEditLineItemAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, - options: - | MethodOptions - | BodyResponseCallback< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - >, - callback: BodyResponseCallback< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - > - ): void; - bulkEditLineItemAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, - callback: BodyResponseCallback< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - > + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkEditLineItemAssignedTargetingOptions( - callback: BodyResponseCallback< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - > + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + callback: BodyResponseCallback ): void; - bulkEditLineItemAssignedTargetingOptions( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions - | BodyResponseCallback< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - > + | Params$Resource$Advertisers$Insertionorders$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - > + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - > + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions; + {}) as Params$Resource$Advertisers$Insertionorders$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions; + params = {} as Params$Resource$Advertisers$Insertionorders$Create; options = {}; } @@ -8234,32 +8455,30 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions' + rootUrl + '/v1/advertisers/{+advertiserId}/insertionOrders' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - >(parameters, callback as BodyResponseCallback<{} | void>); + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); } else { - return createAPIRequest< - Schema$BulkEditLineItemAssignedTargetingOptionsResponse - >(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions - * @desc Lists assigned targeting options of a line item across targeting types. + * displayvideo.advertisers.insertionOrders.delete + * @desc Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. * @example * // Before running the sample: * // - Enable the API at: @@ -8283,66 +8502,16 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions( - * { - * // Required. The ID of the advertiser the line item belongs to. - * advertiserId: '[^/]+', - * // Allows filtering by assigned targeting option properties. - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by the logical operator `OR` on the same - * // field. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)`. - * // * Supported fields: - * // - `targetingType` - * // - `inheritance` - * // - * // Examples: - * // - * // * AssignedTargetingOptions of targeting type - * // TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL - * // `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR - * // targetingType="TARGETING_TYPE_CHANNEL"` - * // * AssignedTargetingOptions with inheritance status of NOT_INHERITED or - * // INHERITED_FROM_PARTNER - * // `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Required. The ID of the line item to list assigned targeting options for. - * lineItemId: '[^/]+', - * // Field by which to sort the list. - * // Acceptable values are: - * // - * // * `targetingType` (default) - * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `targetingType desc`. - * orderBy: 'placeholder-value', - * // Requested page size. - * // The size must be an integer between `1` and `5000`. If unspecified, - * // the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid - * // value is specified. - * pageSize: 'placeholder-value', - * // A token that lets the client fetch the next page of results. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to - * // `BulkListLineItemAssignedTargetingOptions` method. - * // If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * } - * ); + * const res = await displayvideo.advertisers.insertionOrders.delete({ + * // The ID of the advertiser this insertion order belongs to. + * advertiserId: '[^/]+', + * // The ID of the insertion order we need to delete. + * insertionOrderId: '[^/]+', + * }); * console.log(res.data); * * // Example response - * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -8350,85 +8519,60 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions + * @alias displayvideo.advertisers.insertionOrders.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. - * @param {string=} params.filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. - * @param {string} params.lineItemId Required. The ID of the line item to list assigned targeting options for. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. - * @param {integer=} params.pageSize Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * @param {string} params.advertiserId The ID of the advertiser this insertion order belongs to. + * @param {string} params.insertionOrderId The ID of the insertion order we need to delete. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - bulkListLineItemAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, options: StreamMethodOptions ): GaxiosPromise; - bulkListLineItemAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, + delete( + params?: Params$Resource$Advertisers$Insertionorders$Delete, options?: MethodOptions - ): GaxiosPromise; - bulkListLineItemAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkListLineItemAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, - options: - | MethodOptions - | BodyResponseCallback< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - >, - callback: BodyResponseCallback< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - > - ): void; - bulkListLineItemAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, - callback: BodyResponseCallback< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - > + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkListLineItemAssignedTargetingOptions( - callback: BodyResponseCallback< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - > + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + callback: BodyResponseCallback ): void; - bulkListLineItemAssignedTargetingOptions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions - | BodyResponseCallback< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - > + | Params$Resource$Advertisers$Insertionorders$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - > + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - > + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions; + {}) as Params$Resource$Advertisers$Insertionorders$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions; + params = {} as Params$Resource$Advertisers$Insertionorders$Delete; options = {}; } @@ -8443,31 +8587,30 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions' + '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - >(parameters, callback as BodyResponseCallback<{} | void>); + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); } else { - return createAPIRequest< - Schema$BulkListLineItemAssignedTargetingOptionsResponse - >(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.lineItems.create - * @desc Creates a new line item. Returns the newly created line item if successful. + * displayvideo.advertisers.insertionOrders.get + * @desc Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -8491,38 +8634,13 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.create({ - * // Output only. The unique ID of the advertiser the line item belongs to. + * const res = await displayvideo.advertisers.insertionOrders.get({ + * // Required. The ID of the advertiser this insertion order belongs to. * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "inventorySourceIds": [], - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); + * // Required. The ID of the insertion order to fetch. + * insertionOrderId: '[^/]+', + * }); + * console.log(res.data); * * // Example response * // { @@ -8530,21 +8648,15 @@ export namespace displayvideo_v1 { * // "bidStrategy": {}, * // "budget": {}, * // "campaignId": "my_campaignId", - * // "conversionCounting": {}, - * // "creativeIds": [], * // "displayName": "my_displayName", * // "entityStatus": "my_entityStatus", - * // "flight": {}, * // "frequencyCap": {}, * // "insertionOrderId": "my_insertionOrderId", * // "integrationDetails": {}, - * // "inventorySourceIds": [], - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", * // "name": "my_name", * // "pacing": {}, * // "partnerCosts": [], - * // "partnerRevenueModel": {}, + * // "performanceGoal": {}, * // "updateTime": "my_updateTime" * // } * } @@ -8554,60 +8666,60 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.create + * @alias displayvideo.advertisers.insertionOrders.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Output only. The unique ID of the advertiser the line item belongs to. - * @param {().LineItem} params.requestBody Request body data + * @param {string} params.advertiserId Required. The ID of the advertiser this insertion order belongs to. + * @param {string} params.insertionOrderId Required. The ID of the insertion order to fetch. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params: Params$Resource$Advertisers$Lineitems$Create, + get( + params: Params$Resource$Advertisers$Insertionorders$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Advertisers$Lineitems$Create, + get( + params?: Params$Resource$Advertisers$Insertionorders$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Advertisers$Lineitems$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Lineitems$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Lineitems$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Create; + {}) as Params$Resource$Advertisers$Insertionorders$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Create; + params = {} as Params$Resource$Advertisers$Insertionorders$Get; options = {}; } @@ -8621,30 +8733,31 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/advertisers/{+advertiserId}/lineItems' + rootUrl + + '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.lineItems.delete - * @desc Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. + * displayvideo.advertisers.insertionOrders.list + * @desc Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. * @example * // Before running the sample: * // - Enable the API at: @@ -8668,16 +8781,60 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.delete({ - * // The ID of the advertiser this line item belongs to. + * const res = await displayvideo.advertisers.insertionOrders.list({ + * // Required. The ID of the advertiser to list insertion orders for. * advertiserId: '[^/]+', - * // The ID of the line item we need to fetch. - * lineItemId: '[^/]+', + * // Allows filtering by insertion order properties. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by `AND` or `OR` logical operators. A + * // sequence of restrictions implicitly uses `AND`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `campaignId` + * // - `entityStatus` + * // + * // Examples: + * // + * // * All insertion orders under a campaign: `campaignId="1234"` + * // * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders + * // under an advertiser: + * // `(entityStatus="ENTITY_STATUS_ACTIVE" OR + * // entityStatus="ENTITY_STATUS_PAUSED")` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * "displayName" (default) + * // * "entityStatus" + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // Typically, this is the value of + * // next_page_token returned + * // from the previous call to `ListInsertionOrders` method. If not specified, + * // the first page of results will be returned. + * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "insertionOrders": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -8685,60 +8842,70 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.delete + * @alias displayvideo.advertisers.insertionOrders.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId The ID of the advertiser this line item belongs to. - * @param {string} params.lineItemId The ID of the line item we need to fetch. + * @param {string} params.advertiserId Required. The ID of the advertiser to list insertion orders for. + * @param {string=} params.filter Allows filtering by insertion order properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `entityStatus` Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params: Params$Resource$Advertisers$Lineitems$Delete, + list( + params: Params$Resource$Advertisers$Insertionorders$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Advertisers$Lineitems$Delete, + list( + params?: Params$Resource$Advertisers$Insertionorders$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Advertisers$Lineitems$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Insertionorders$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Lineitems$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Insertionorders$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Lineitems$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Insertionorders$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Delete; + {}) as Params$Resource$Advertisers$Insertionorders$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Delete; + params = {} as Params$Resource$Advertisers$Insertionorders$List; options = {}; } @@ -8752,31 +8919,30 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + rootUrl + '/v1/advertisers/{+advertiserId}/insertionOrders' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.lineItems.get - * @desc Gets a line item. + * displayvideo.advertisers.insertionOrders.patch + * @desc Updates an existing insertion order. Returns the updated insertion order if successful. * @example * // Before running the sample: * // - Enable the API at: @@ -8800,35 +8966,52 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.get({ - * // Required. The ID of the advertiser this line item belongs to. + * const res = await displayvideo.advertisers.insertionOrders.patch({ + * // Output only. The unique ID of the advertiser the insertion order belongs to. * advertiserId: '[^/]+', - * // Required. The ID of the line item to fetch. - * lineItemId: '[^/]+', - * }); - * console.log(res.data); + * // Output only. The unique ID of the insertion order. Assigned by the system. + * insertionOrderId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', * - * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "inventorySourceIds": [], - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "name": "my_name", + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "performanceGoal": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "name": "my_name", * // "pacing": {}, * // "partnerCosts": [], - * // "partnerRevenueModel": {}, + * // "performanceGoal": {}, * // "updateTime": "my_updateTime" * // } * } @@ -8838,60 +9021,62 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.get + * @alias displayvideo.advertisers.insertionOrders.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser this line item belongs to. - * @param {string} params.lineItemId Required. The ID of the line item to fetch. + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the insertion order belongs to. + * @param {string} params.insertionOrderId Output only. The unique ID of the insertion order. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().InsertionOrder} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Advertisers$Lineitems$Get, + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Advertisers$Lineitems$Get, + patch( + params?: Params$Resource$Advertisers$Insertionorders$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertisers$Lineitems$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Lineitems$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Lineitems$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Get; + {}) as Params$Resource$Advertisers$Insertionorders$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Get; + params = {} as Params$Resource$Advertisers$Insertionorders$Patch; options = {}; } @@ -8906,30 +9091,119 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Insertionorders$Create + extends StandardParameters { /** - * displayvideo.advertisers.lineItems.list - * @desc Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + export interface Params$Resource$Advertisers$Insertionorders$Delete + extends StandardParameters { + /** + * The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * The ID of the insertion order we need to delete. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the insertion order to fetch. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list insertion orders for. + */ + advertiserId?: string; + /** + * Allows filtering by insertion order properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `entityStatus` Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the insertion order. Assigned by the system. + */ + insertionOrderId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + + export class Resource$Advertisers$Lineitems { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Lineitems$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Lineitems$Targetingtypes( + this.context + ); + } + + /** + * displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions + * @desc Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests . * @example * // Before running the sample: * // - Enable the API at: @@ -8953,62 +9227,28 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.list({ - * // Required. The ID of the advertiser to list line items for. - * advertiserId: '[^/]+', - * // Allows filtering by line item properties. - * // - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by `AND` or `OR` logical operators. A - * // sequence of restrictions implicitly uses `AND`. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)`. - * // * Supported fields: - * // - `campaignId` - * // - `insertionOrderId` - * // - `entityStatus` - * // - `lineItemType`. - * // - * // Examples: - * // - * // * All line items under an insertion order: `insertionOrderId="1234"` - * // * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` - * // and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: - * // `(entityStatus="ENTITY_STATUS_ACTIVE" OR - * // entityStatus="ENTITY_STATUS_PAUSED") AND - * // lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Field by which to sort the list. - * // Acceptable values are: - * // - * // * "displayName" (default) - * // * "entityStatus" - * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - * // is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListLineItems` method. - * // If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * }); - * console.log(res.data); + * const res = await displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the line item the assigned targeting option will belong to. + * lineItemId: '[^/]+', * - * // Example response - * // { - * // "lineItems": [], - * // "nextPageToken": "my_nextPageToken" + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createRequests": [], + * // "deleteRequests": [] + * // } + * }, + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "createdAssignedTargetingOptions": [] * // } * } * @@ -9017,68 +9257,82 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.list + * @alias displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser to list line items for. - * @param {string=} params.filter Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `insertionOrderId` - `entityStatus` - `lineItemType`. Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option will belong to. + * @param {().BulkEditLineItemAssignedTargetingOptionsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params: Params$Resource$Advertisers$Lineitems$List, + bulkEditLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Advertisers$Lineitems$List, + bulkEditLineItemAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Advertisers$Lineitems$List, + ): GaxiosPromise; + bulkEditLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Lineitems$List, + bulkEditLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + >, + callback: BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > ): void; - list( - params: Params$Resource$Advertisers$Lineitems$List, - callback: BodyResponseCallback + bulkEditLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, + callback: BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > ): void; - list(callback: BodyResponseCallback): void; - list( + bulkEditLineItemAssignedTargetingOptions( + callback: BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkEditLineItemAssignedTargetingOptions( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$List - | BodyResponseCallback + | Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions + | BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$List; + {}) as Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$List; + params = {} as Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions; options = {}; } @@ -9092,30 +9346,32 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/advertisers/{+advertiserId}/lineItems' + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback<{} | void> - ); + createAPIRequest< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + >(parameters, callback as BodyResponseCallback<{} | void>); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + >(parameters); } } /** - * displayvideo.advertisers.lineItems.patch - * @desc Updates an existing line item. Returns the updated line item if successful. + * displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions + * @desc Lists assigned targeting options of a line item across targeting types. * @example * // Before running the sample: * // - Enable the API at: @@ -9139,65 +9395,65 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.patch({ - * // Output only. The unique ID of the advertiser the line item belongs to. - * advertiserId: '[^/]+', - * // Output only. The unique ID of the line item. Assigned by the system. - * lineItemId: '[^/]+', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "inventorySourceIds": [], - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Allows filtering by assigned targeting option properties. + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by the logical operator `OR` on the same + * // field. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `targetingType` + * // - `inheritance` + * // + * // Examples: + * // + * // * AssignedTargetingOptions of targeting type + * // TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL + * // `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR + * // targetingType="TARGETING_TYPE_CHANNEL"` + * // * AssignedTargetingOptions with inheritance status of NOT_INHERITED or + * // INHERITED_FROM_PARTNER + * // `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Required. The ID of the line item to list assigned targeting options for. + * lineItemId: '[^/]+', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `targetingType` (default) + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `targetingType desc`. + * orderBy: 'placeholder-value', + * // Requested page size. + * // The size must be an integer between `1` and `5000`. If unspecified, + * // the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid + * // value is specified. + * pageSize: 'placeholder-value', + * // A token that lets the client fetch the next page of results. + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to + * // `BulkListLineItemAssignedTargetingOptions` method. + * // If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * } + * ); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "inventorySourceIds": [], - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "updateTime": "my_updateTime" + * // "assignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -9206,62 +9462,5266 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.patch + * @alias displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Output only. The unique ID of the advertiser the line item belongs to. - * @param {string} params.lineItemId Output only. The unique ID of the line item. Assigned by the system. - * @param {string=} params.updateMask Required. The mask to control which fields to update. - * @param {().LineItem} params.requestBody Request body data + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string=} params.filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + * @param {string} params.lineItemId Required. The ID of the line item to list assigned targeting options for. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + * @param {integer=} params.pageSize Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - patch( - params: Params$Resource$Advertisers$Lineitems$Patch, + bulkListLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Advertisers$Lineitems$Patch, + bulkListLineItemAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Advertisers$Lineitems$Patch, + ): GaxiosPromise; + bulkListLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Lineitems$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Advertisers$Lineitems$Patch, - callback: BodyResponseCallback + bulkListLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + >, + callback: BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkListLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, + callback: BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkListLineItemAssignedTargetingOptions( + callback: BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkListLineItemAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions + | BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + | BodyResponseCallback, + callback?: + | BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + >(parameters, callback as BodyResponseCallback<{} | void>); + } else { + return createAPIRequest< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + >(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.create + * @desc Creates a new line item. Returns the newly created line item if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.create({ + * // Output only. The unique ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "inventorySourceIds": [], + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "inventorySourceIds": [], + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the line item belongs to. + * @param {().LineItem} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Lineitems$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.delete + * @desc Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.delete({ + * // The ID of the advertiser this line item belongs to. + * advertiserId: '[^/]+', + * // The ID of the line item we need to fetch. + * lineItemId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser this line item belongs to. + * @param {string} params.lineItemId The ID of the line item we need to fetch. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Lineitems$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.get + * @desc Gets a line item. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.get({ + * // Required. The ID of the advertiser this line item belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the line item to fetch. + * lineItemId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "inventorySourceIds": [], + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser this line item belongs to. + * @param {string} params.lineItemId Required. The ID of the line item to fetch. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Lineitems$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.list + * @desc Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.list({ + * // Required. The ID of the advertiser to list line items for. + * advertiserId: '[^/]+', + * // Allows filtering by line item properties. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by `AND` or `OR` logical operators. A + * // sequence of restrictions implicitly uses `AND`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `campaignId` + * // - `insertionOrderId` + * // - `entityStatus` + * // - `lineItemType`. + * // + * // Examples: + * // + * // * All line items under an insertion order: `insertionOrderId="1234"` + * // * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` + * // and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: + * // `(entityStatus="ENTITY_STATUS_ACTIVE" OR + * // entityStatus="ENTITY_STATUS_PAUSED") AND + * // lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * "displayName" (default) + * // * "entityStatus" + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListLineItems` method. + * // If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "lineItems": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser to list line items for. + * @param {string=} params.filter Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `insertionOrderId` - `entityStatus` - `lineItemType`. Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Lineitems$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.patch + * @desc Updates an existing line item. Returns the updated line item if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.patch({ + * // Output only. The unique ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the line item. Assigned by the system. + * lineItemId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "inventorySourceIds": [], + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "inventorySourceIds": [], + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the line item belongs to. + * @param {string} params.lineItemId Output only. The unique ID of the line item. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().LineItem} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Lineitems$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item the assigned targeting option will belong to. + */ + lineItemId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditLineItemAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Required. The ID of the line item to list assigned targeting options for. + */ + lineItemId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + export interface Params$Resource$Advertisers$Lineitems$Delete + extends StandardParameters { + /** + * The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * The ID of the line item we need to fetch. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item to fetch. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list line items for. + */ + advertiserId?: string; + /** + * Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `insertionOrderId` - `entityStatus` - `lineItemType`. Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the line item. Assigned by the system. + */ + lineItemId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + + export class Resource$Advertisers$Lineitems$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = new Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create + * @desc Assigns a targeting option to a line item. Returns the assigned targeting option if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the line item the assigned targeting option will belong to. + * lineItemId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. + * targetingType: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "audienceGroupDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "negativeKeywordListDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {} + * // } + * }, + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "audienceGroupDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "negativeKeywordListDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option will belong to. + * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {().AssignedTargetingOption} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete + * @desc Deletes an assigned targeting option from a line item. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the assigned targeting option to delete. + * assignedTargetingOptionId: '[^/]+', + * // Required. The ID of the line item the assigned targeting option belongs to. + * lineItemId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. + * targetingType: '[^/]+', + * } + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string} params.assignedTargetingOptionId Required. The ID of the assigned targeting option to delete. + * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option belongs to. + * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get + * @desc Gets a single targeting option assigned to a line item. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Required. An identifier unique to the targeting type in this line item that + * // identifies the assigned targeting option being requested. + * assignedTargetingOptionId: '[^/]+', + * // Required. The ID of the line item the assigned targeting option belongs to. + * lineItemId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. + * targetingType: '[^/]+', + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "audienceGroupDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "negativeKeywordListDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string} params.assignedTargetingOptionId Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option belongs to. + * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list + * @desc Lists the targeting options assigned to a line item. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Allows filtering by assigned targeting option properties. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by the logical operator `OR`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `assignedTargetingOptionId` + * // - `inheritance` + * // + * // Examples: + * // + * // * AssignedTargetingOptions with ID 1 or 2 + * // `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` + * // * AssignedTargetingOptions with inheritance status of NOT_INHERITED or + * // INHERITED_FROM_PARTNER + * // `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Required. The ID of the line item to list assigned targeting options for. + * lineItemId: '[^/]+', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `assignedTargetingOptionId` (default) + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `assignedTargetingOptionId desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListLineItemAssignedTargetingOptions` + * // method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // Required. Identifies the type of assigned targeting options to list. + * targetingType: '[^/]+', + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "assignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string=} params.filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + * @param {string} params.lineItemId Required. The ID of the line item to list assigned targeting options for. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * @param {string} params.targetingType Required. Identifies the type of assigned targeting options to list. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + >, + callback: BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + | BodyResponseCallback, + callback?: + | BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest< + Schema$ListLineItemAssignedTargetingOptionsResponse + >(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item the assigned targeting option will belong to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Required. The ID of the line item to list assigned targeting options for. + */ + lineItemId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. + */ + targetingType?: string; + } + + export class Resource$Advertisers$Locationlists { + context: APIRequestContext; + assignedLocations: Resource$Advertisers$Locationlists$Assignedlocations; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedLocations = new Resource$Advertisers$Locationlists$Assignedlocations( + this.context + ); + } + + /** + * displayvideo.advertisers.locationLists.create + * @desc Creates a new location list. Returns the newly created location list if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.locationLists.create({ + * // Required. The ID of the DV360 advertiser to which the location list belongs. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "locationListId": "my_locationListId", + * // "locationType": "my_locationType", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "locationListId": "my_locationListId", + * // "locationType": "my_locationType", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.locationLists.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the location list belongs. + * @param {().LocationList} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params: Params$Resource$Advertisers$Locationlists$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Locationlists$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/locationLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.locationLists.get + * @desc Gets a location list. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.locationLists.get({ + * // Required. The ID of the DV360 advertiser to which the fetched location list belongs. + * advertiserId: '[^/]+', + * // Required. The ID of the location list to fetch. + * locationListId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "locationListId": "my_locationListId", + * // "locationType": "my_locationType", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.locationLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched location list belongs. + * @param {string} params.locationListId Required. The ID of the location list to fetch. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Locationlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/locationLists/{+locationListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.locationLists.list + * @desc Lists location lists based on a given advertiser id. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.locationLists.list({ + * // Required. The ID of the DV360 advertiser to which the fetched location lists belong. + * advertiserId: '[^/]+', + * // Allows filtering by location list fields. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by `AND` or `OR` logical operators. A + * // sequence of restrictions implicitly uses `AND`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `locationType` + * // + * // Examples: + * // + * // * All regional location list: + * // `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` + * // * All proximity location list: + * // `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `locationListId` (default) + * // * `displayName` + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. + * // Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an + * // invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListLocationLists` method. + * // If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "locationLists": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.locationLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched location lists belong. + * @param {string=} params.filter Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Locationlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/locationLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.locationLists.patch + * @desc Updates a location list. Returns the updated location list if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.locationLists.patch({ + * // Required. The ID of the DV360 advertiser to which the location lists belongs. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the location list. Assigned by the system. + * locationListId: 'placeholder-value', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "locationListId": "my_locationListId", + * // "locationType": "my_locationType", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "locationListId": "my_locationListId", + * // "locationType": "my_locationType", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.locationLists.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the location lists belongs. + * @param {string} params.locationListId Output only. The unique ID of the location list. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().LocationList} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Locationlists$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/locationLists/{locationListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Locationlists$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LocationList; + } + export interface Params$Resource$Advertisers$Locationlists$Get + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list to fetch. + */ + locationListId?: string; + } + export interface Params$Resource$Advertisers$Locationlists$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched location lists belong. + */ + advertiserId?: string; + /** + * Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Locationlists$Patch + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location lists belongs. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the location list. Assigned by the system. + */ + locationListId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LocationList; + } + + export class Resource$Advertisers$Locationlists$Assignedlocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.locationLists.assignedLocations.bulkEdit + * @desc Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.locationLists.assignedLocations.bulkEdit( + * { + * // Required. The ID of the DV360 advertiser to which the location list belongs. + * advertiserId: 'placeholder-value', + * // Required. The ID of the location list to which these assignments are assigned. + * locationListId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createdAssignedLocations": [], + * // "deletedAssignedLocations": [] + * // } + * }, + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "assignedLocations": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.locationLists.assignedLocations.bulkEdit + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the location list belongs. + * @param {string} params.locationListId Required. The ID of the location list to which these assignments are assigned. + * @param {().BulkEditAssignedLocationsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * displayvideo.advertisers.locationLists.assignedLocations.create + * @desc Creates an assignment between a location and a location list. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.locationLists.assignedLocations.create( + * { + * // Required. The ID of the DV360 advertiser to which the location list belongs. + * advertiserId: 'placeholder-value', + * // Required. The ID of the location list for which the assignment will be created. + * locationListId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "assignedLocationId": "my_assignedLocationId", + * // "name": "my_name", + * // "targetingOptionId": "my_targetingOptionId" + * // } + * }, + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "assignedLocationId": "my_assignedLocationId", + * // "name": "my_name", + * // "targetingOptionId": "my_targetingOptionId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.locationLists.assignedLocations.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the location list belongs. + * @param {string} params.locationListId Required. The ID of the location list for which the assignment will be created. + * @param {().AssignedLocation} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.locationLists.assignedLocations.delete + * @desc Deletes the assignment between a location and a location list. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.locationLists.assignedLocations.delete( + * { + * // Required. The ID of the DV360 advertiser to which the location list belongs. + * advertiserId: 'placeholder-value', + * // Required. The ID of the assigned location to delete. + * assignedLocationId: '[^/]+', + * // Required. The ID of the location list to which this assignment is assigned. + * locationListId: 'placeholder-value', + * } + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.locationLists.assignedLocations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the location list belongs. + * @param {string} params.assignedLocationId Required. The ID of the assigned location to delete. + * @param {string} params.locationListId Required. The ID of the location list to which this assignment is assigned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'locationListId', + 'assignedLocationId', + ], + pathParams: ['advertiserId', 'assignedLocationId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.locationLists.assignedLocations.list + * @desc Lists locations assigned to a location list. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.locationLists.assignedLocations.list( + * { + * // Required. The ID of the DV360 advertiser to which the location list belongs. + * advertiserId: 'placeholder-value', + * // Allows filtering by location list assignment fields. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by the logical operator `OR`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `assignedLocationId` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Required. The ID of the location list to which these assignments are assigned. + * locationListId: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `assignedLocationId` (default) + * // + * // The default sorting order is ascending. To specify descending order for a + * // field, a suffix " desc" should be added to the field name. Example: + * // `assignedLocationId desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListAssignedLocations` + * // method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "assignedLocations": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.locationLists.assignedLocations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the location list belongs. + * @param {string=} params.filter Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedLocationId` The length of this field should be no more than 500 characters. + * @param {string} params.locationListId Required. The ID of the location list to which these assignments are assigned. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedLocationId desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list to which these assignments are assigned. + */ + locationListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedLocationsRequest; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list for which the assignment will be created. + */ + locationListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedLocation; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned location to delete. + */ + assignedLocationId?: string; + /** + * Required. The ID of the location list to which this assignment is assigned. + */ + locationListId?: string; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedLocationId` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Required. The ID of the location list to which these assignments are assigned. + */ + locationListId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedLocationId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Negativekeywordlists { + context: APIRequestContext; + negativeKeywords: Resource$Advertisers$Negativekeywordlists$Negativekeywords; + constructor(context: APIRequestContext) { + this.context = context; + this.negativeKeywords = new Resource$Advertisers$Negativekeywordlists$Negativekeywords( + this.context + ); + } + + /** + * displayvideo.advertisers.negativeKeywordLists.create + * @desc Creates a new negative keyword list. Returns the newly created negative keyword list if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.create({ + * // Required. The ID of the DV360 advertiser to which the negative keyword list will + * // belong. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativeKeywordListId": "my_negativeKeywordListId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativeKeywordListId": "my_negativeKeywordListId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the negative keyword list will belong. + * @param {().NegativeKeywordList} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Negativekeywordlists$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/negativeKeywordLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.negativeKeywordLists.delete + * @desc Deletes a negative keyword list given an advertiser ID and a negative keyword list ID. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.delete({ + * // Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + * advertiserId: '[^/]+', + * // Required. The ID of the negative keyword list to delete. + * negativeKeywordListId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + * @param {string} params.negativeKeywordListId Required. The ID of the negative keyword list to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.negativeKeywordLists.get + * @desc Gets a negative keyword list given an advertiser ID and a negative keyword list ID. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.get({ + * // Required. The ID of the DV360 advertiser to which the fetched negative keyword list + * // belongs. + * advertiserId: '[^/]+', + * // Required. The ID of the negative keyword list to fetch. + * negativeKeywordListId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativeKeywordListId": "my_negativeKeywordListId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. + * @param {string} params.negativeKeywordListId Required. The ID of the negative keyword list to fetch. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Negativekeywordlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.negativeKeywordLists.list + * @desc Lists negative keyword lists based on a given advertiser id. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.list({ + * // Required. The ID of the DV360 advertiser to which the fetched negative keyword lists + * // belong. + * advertiserId: '[^/]+', + * // Requested page size. Must be between `1` and `100`. + * // Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an + * // invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListNegativeKeywordLists` method. + * // If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "negativeKeywordLists": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Negativekeywordlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/negativeKeywordLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * displayvideo.advertisers.negativeKeywordLists.patch + * @desc Updates a negative keyword list. Returns the updated negative keyword list if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.patch({ + * // Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the negative keyword list. Assigned by the system. + * negativeKeywordListId: 'placeholder-value', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativeKeywordListId": "my_negativeKeywordListId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativeKeywordListId": "my_negativeKeywordListId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + * @param {string} params.negativeKeywordListId Output only. The unique ID of the negative keyword list. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().NegativeKeywordList} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Negativekeywordlists$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list will belong. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeywordList; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the negative keyword list to delete. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Get + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the negative keyword list to fetch. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. + */ + advertiserId?: string; + /** + * Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Patch + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the negative keyword list. Assigned by the system. + */ + negativeKeywordListId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeywordList; + } + + export class Resource$Advertisers$Negativekeywordlists$Negativekeywords { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit + * @desc Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit( + * { + * // Required. The ID of the DV360 advertiser to which the parent negative keyword list + * // belongs. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent negative keyword list to which the negative keywords + * // belong. + * negativeKeywordListId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createdNegativeKeywords": [], + * // "deletedNegativeKeywords": [] + * // } + * }, + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "negativeKeywords": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + * @param {string} params.negativeKeywordListId Required. The ID of the parent negative keyword list to which the negative keywords belong. + * @param {().BulkEditNegativeKeywordsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create + * @desc Creates a negative keyword in a negative keyword list. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create( + * { + * // Required. The ID of the DV360 advertiser to which the parent negative keyword list + * // belongs. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent negative keyword list in which the negative keyword + * // will be created. + * negativeKeywordListId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "keywordValue": "my_keywordValue", + * // "name": "my_name" + * // } + * }, + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "keywordValue": "my_keywordValue", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + * @param {string} params.negativeKeywordListId Required. The ID of the parent negative keyword list in which the negative keyword will be created. + * @param {().NegativeKeyword} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete + * @desc Deletes a negative keyword from a negative keyword list. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete( + * { + * // Required. The ID of the DV360 advertiser to which the parent negative keyword list + * // belongs. + * advertiserId: 'placeholder-value', + * // Required. The keyword value of the negative keyword to delete. + * keywordValue: '[^/]+', + * // Required. The ID of the parent negative keyword list to which the negative keyword + * // belongs. + * negativeKeywordListId: '[^/]+', + * } + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + * @param {string} params.keywordValue Required. The keyword value of the negative keyword to delete. + * @param {string} params.negativeKeywordListId Required. The ID of the parent negative keyword list to which the negative keyword belongs. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'negativeKeywordListId', + 'keywordValue', + ], + pathParams: ['advertiserId', 'keywordValue', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list + * @desc Lists negative keywords in a negative keyword list. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list( + * { + * // Required. The ID of the DV360 advertiser to which the parent negative keyword list + * // belongs. + * advertiserId: '[^/]+', + * // Allows filtering by negative keyword fields. + * // + * // Supported syntax: + * // + * // * Filter expressions for negative keyword currently can only contain at + * // most one + * // * restriction. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `CONTAINS (:)`. + * // * Supported fields: + * // - `keywordValue` + * // + * // Examples: + * // + * // * All negative keywords for which the keyword value contains "google": + * // `keywordValue : "google"` + * filter: 'placeholder-value', + * // Required. The ID of the parent negative keyword list to which the requested negative + * // keywords belong. + * negativeKeywordListId: '[^/]+', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `keywordValue` (default) + * // + * // The default sorting order is ascending. To specify descending order for a + * // field, a suffix " desc" should be added to the field name. Example: + * // `keywordValue desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // + * // Typically, this is the value of + * // next_page_token returned + * // from the previous call to `ListNegativeKeywords` method. If not specified, + * // the first page of results will be returned. + * pageToken: 'placeholder-value', + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "negativeKeywords": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + * @param {string=} params.filter Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keyword currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` + * @param {string} params.negativeKeywordListId Required. The ID of the parent negative keyword list to which the requested negative keywords belong. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the parent negative keyword list to which the negative keywords belong. + */ + negativeKeywordListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditNegativeKeywordsRequest; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the parent negative keyword list in which the negative keyword will be created. + */ + negativeKeywordListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeyword; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The keyword value of the negative keyword to delete. + */ + keywordValue?: string; + /** + * Required. The ID of the parent negative keyword list to which the negative keyword belongs. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keyword currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` + */ + filter?: string; + /** + * Required. The ID of the parent negative keyword list to which the requested negative keywords belong. + */ + negativeKeywordListId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = new Resource$Advertisers$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create + * @desc Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create( + * { + * // Required. The ID of the advertiser. + * advertiserId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. + * targetingType: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "audienceGroupDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "negativeKeywordListDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {} + * // } + * }, + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "audienceGroupDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "negativeKeywordListDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser. + * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {().AssignedTargetingOption} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'targetingType'], + pathParams: ['advertiserId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete + * @desc Deletes an assigned targeting option from an advertiser. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete( + * { + * // Required. The ID of the advertiser. + * advertiserId: '[^/]+', + * // Required. The ID of the assigned targeting option to delete. + * assignedTargetingOptionId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. + * targetingType: '[^/]+', + * } + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser. + * @param {string} params.assignedTargetingOptionId Required. The ID of the assigned targeting option to delete. + * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Patch - | BodyResponseCallback + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Patch; + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Patch; + params = {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete; options = {}; } @@ -9276,169 +14736,38 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + '/v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: [ + 'advertiserId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions - extends StandardParameters { - /** - * Required. The ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the line item the assigned targeting option will belong to. - */ - lineItemId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BulkEditLineItemAssignedTargetingOptionsRequest; - } - export interface Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions - extends StandardParameters { - /** - * Required. The ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - /** - * Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Required. The ID of the line item to list assigned targeting options for. - */ - lineItemId?: string; - /** - * Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. - */ - orderBy?: string; - /** - * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Lineitems$Create - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LineItem; - } - export interface Params$Resource$Advertisers$Lineitems$Delete - extends StandardParameters { - /** - * The ID of the advertiser this line item belongs to. - */ - advertiserId?: string; - /** - * The ID of the line item we need to fetch. - */ - lineItemId?: string; - } - export interface Params$Resource$Advertisers$Lineitems$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser this line item belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the line item to fetch. - */ - lineItemId?: string; - } - export interface Params$Resource$Advertisers$Lineitems$List - extends StandardParameters { - /** - * Required. The ID of the advertiser to list line items for. - */ - advertiserId?: string; - /** - * Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `insertionOrderId` - `entityStatus` - `lineItemType`. Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Lineitems$Patch - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - /** - * Output only. The unique ID of the line item. Assigned by the system. - */ - lineItemId?: string; - /** - * Required. The mask to control which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LineItem; - } - - export class Resource$Advertisers$Lineitems$Targetingtypes { - context: APIRequestContext; - assignedTargetingOptions: Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions; - constructor(context: APIRequestContext) { - this.context = context; - this.assignedTargetingOptions = new Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions( - this.context - ); - } - } - - export class Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create - * @desc Assigns a targeting option to a line item. Returns the assigned targeting option if successful. + * displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get + * @desc Gets a single targeting option assigned to an advertiser. * @example * // Before running the sample: * // - Enable the API at: @@ -9462,62 +14791,15 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create( + * const res = await displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get( * { - * // Required. The ID of the advertiser the line item belongs to. + * // Required. The ID of the advertiser. * advertiserId: '[^/]+', - * // Required. The ID of the line item the assigned targeting option will belong to. - * lineItemId: '[^/]+', + * // Required. An identifier unique to the targeting type in this advertiser that + * // identifies the assigned targeting option being requested. + * assignedTargetingOptionId: '[^/]+', * // Required. Identifies the type of this assigned targeting option. * targetingType: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "audienceGroupDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "negativeKeywordListDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {} - * // } - * }, * } * ); * console.log(res.data); @@ -9573,48 +14855,45 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create + * @alias displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. - * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option will belong to. + * @param {string} params.advertiserId Required. The ID of the advertiser. + * @param {string} params.assignedTargetingOptionId Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. - * @param {().AssignedTargetingOption} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + get( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, - callback: BodyResponseCallback - ): void; - create( + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, callback: BodyResponseCallback ): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9630,12 +14909,12 @@ export namespace displayvideo_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + params = {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get; options = {}; } @@ -9650,15 +14929,23 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + '/v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], - pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + requiredParams: [ + 'advertiserId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], context: this.context, }; if (callback) { @@ -9672,8 +14959,8 @@ export namespace displayvideo_v1 { } /** - * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete - * @desc Deletes an assigned targeting option from a line item. + * displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list + * @desc Lists the targeting options assigned to an advertiser. * @example * // Before running the sample: * // - Enable the API at: @@ -9697,22 +14984,58 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete( + * const res = await displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list( * { - * // Required. The ID of the advertiser the line item belongs to. + * // Required. The ID of the advertiser. * advertiserId: '[^/]+', - * // Required. The ID of the assigned targeting option to delete. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the line item the assigned targeting option belongs to. - * lineItemId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. + * // Allows filtering by assigned targeting option properties. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by the logical operator `OR`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `assignedTargetingOptionId` + * // + * // Examples: + * // + * // * AssignedTargetingOption with ID 123456 + * // `assignedTargetingOptionId="123456"` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `assignedTargetingOptionId` (default) + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `assignedTargetingOptionId desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListAdvertiserAssignedTargetingOptions` + * // method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // Required. Identifies the type of assigned targeting options to list. * targetingType: '[^/]+', * } * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "assignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -9720,62 +15043,85 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete + * @alias displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. - * @param {string} params.assignedTargetingOptionId Required. The ID of the assigned targeting option to delete. - * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option belongs to. - * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {string} params.advertiserId Required. The ID of the advertiser. + * @param {string=} params.filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * @param {string} params.targetingType Required. Identifies the type of assigned targeting options to list. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + list( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback< + Schema$ListAdvertiserAssignedTargetingOptionsResponse + >, + callback: BodyResponseCallback< + Schema$ListAdvertiserAssignedTargetingOptionsResponse + > ): void; - delete( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback< + Schema$ListAdvertiserAssignedTargetingOptionsResponse + > ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback< + Schema$ListAdvertiserAssignedTargetingOptionsResponse + > + ): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback< + Schema$ListAdvertiserAssignedTargetingOptionsResponse + > | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback< + Schema$ListAdvertiserAssignedTargetingOptionsResponse + > | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback< + Schema$ListAdvertiserAssignedTargetingOptionsResponse + > | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + params = {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List; options = {}; } @@ -9784,46 +15130,119 @@ export namespace displayvideo_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: [ - 'advertiserId', - 'lineItemId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'lineItemId', - 'targetingType', - ], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback<{} | void> - ); - } else { - return createAPIRequest(parameters); - } + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'targetingType'], + pathParams: ['advertiserId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest< + Schema$ListAdvertiserAssignedTargetingOptionsResponse + >(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. + */ + targetingType?: string; + } + + export class Resource$Combinedaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get - * @desc Gets a single targeting option assigned to a line item. + * displayvideo.combinedAudiences.get + * @desc Gets a combined audience. * @example * // Before running the sample: * // - Enable the API at: @@ -9847,64 +15266,22 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get( - * { - * // Required. The ID of the advertiser the line item belongs to. - * advertiserId: '[^/]+', - * // Required. An identifier unique to the targeting type in this line item that - * // identifies the assigned targeting option being requested. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the line item the assigned targeting option belongs to. - * lineItemId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. - * targetingType: '[^/]+', - * } - * ); + * const res = await displayvideo.combinedAudiences.get({ + * // The ID of the advertiser that has access to the fetched combined + * // audience. + * advertiserId: 'placeholder-value', + * // Required. The ID of the combined audience to fetch. + * combinedAudienceId: '[^/]+', + * // The ID of the partner that has access to the fetched combined audience. + * partnerId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "audienceGroupDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "negativeKeywordListDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {} + * // "combinedAudienceId": "my_combinedAudienceId", + * // "displayName": "my_displayName", + * // "name": "my_name" * // } * } * @@ -9913,67 +15290,61 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get + * @alias displayvideo.combinedAudiences.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. - * @param {string} params.assignedTargetingOptionId Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. - * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option belongs to. - * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched combined audience. + * @param {string} params.combinedAudienceId Required. The ID of the combined audience to fetch. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched combined audience. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + params: Params$Resource$Combinedaudiences$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + params?: Params$Resource$Combinedaudiences$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + params: Params$Resource$Combinedaudiences$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Combinedaudiences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, - callback: BodyResponseCallback + params: Params$Resource$Combinedaudiences$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get - | BodyResponseCallback + | Params$Resource$Combinedaudiences$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + {}) as Params$Resource$Combinedaudiences$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + params = {} as Params$Resource$Combinedaudiences$Get; options = {}; } @@ -9987,41 +15358,30 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + rootUrl + '/v1/combinedAudiences/{+combinedAudienceId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: [ - 'advertiserId', - 'lineItemId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'lineItemId', - 'targetingType', - ], + requiredParams: ['combinedAudienceId'], + pathParams: ['combinedAudienceId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list - * @desc Lists the targeting options assigned to a line item. + * displayvideo.combinedAudiences.list + * @desc Lists combined audiences. The order is defined by the order_by parameter. * @example * // Before running the sample: * // - Enable the API at: @@ -10039,68 +15399,62 @@ export namespace displayvideo_v1 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/display-video'], * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list( - * { - * // Required. The ID of the advertiser the line item belongs to. - * advertiserId: '[^/]+', - * // Allows filtering by assigned targeting option properties. - * // - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by the logical operator `OR`. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)`. - * // * Supported fields: - * // - `assignedTargetingOptionId` - * // - `inheritance` - * // - * // Examples: - * // - * // * AssignedTargetingOptions with ID 1 or 2 - * // `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` - * // * AssignedTargetingOptions with inheritance status of NOT_INHERITED or - * // INHERITED_FROM_PARTNER - * // `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Required. The ID of the line item to list assigned targeting options for. - * lineItemId: '[^/]+', - * // Field by which to sort the list. - * // Acceptable values are: - * // - * // * `assignedTargetingOptionId` (default) - * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `assignedTargetingOptionId desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - * // is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListLineItemAssignedTargetingOptions` - * // method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // Required. Identifies the type of assigned targeting options to list. - * targetingType: '[^/]+', - * } - * ); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.combinedAudiences.list({ + * // The ID of the advertiser that has access to the fetched combined + * // audiences. + * advertiserId: 'placeholder-value', + * // Allows filtering by combined audience fields. + * // + * // Supported syntax: + * // + * // * Filter expressions for combined audiences currently can only contain at + * // most one restriction. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `CONTAINS (:)`. + * // * Supported fields: + * // - `displayName` + * // + * // Examples: + * // + * // * All combined audiences for which the display name contains "Google": + * // `displayName : "Google"`. + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `combinedAudienceId` (default) + * // * `displayName` + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListCombinedAudiences` method. + * // If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // The ID of the partner that has access to the fetched combined audiences. + * partnerId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], + * // "combinedAudiences": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -10110,86 +15464,71 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list + * @alias displayvideo.combinedAudiences.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. - * @param {string=} params.filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. - * @param {string} params.lineItemId Required. The ID of the line item to list assigned targeting options for. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched combined audiences. + * @param {string=} params.filter Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * @param {string} params.targetingType Required. Identifies the type of assigned targeting options to list. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched combined audiences. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Combinedaudiences$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + params?: Params$Resource$Combinedaudiences$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Combinedaudiences$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Combinedaudiences$List, options: | MethodOptions - | BodyResponseCallback< - Schema$ListLineItemAssignedTargetingOptionsResponse - >, - callback: BodyResponseCallback< - Schema$ListLineItemAssignedTargetingOptionsResponse - > + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, - callback: BodyResponseCallback< - Schema$ListLineItemAssignedTargetingOptionsResponse - > + params: Params$Resource$Combinedaudiences$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback< - Schema$ListLineItemAssignedTargetingOptionsResponse - > + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List - | BodyResponseCallback< - Schema$ListLineItemAssignedTargetingOptionsResponse - > + | Params$Resource$Combinedaudiences$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback< - Schema$ListLineItemAssignedTargetingOptionsResponse - > + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback< - Schema$ListLineItemAssignedTargetingOptionsResponse - > + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + {}) as Params$Resource$Combinedaudiences$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + params = {} as Params$Resource$Combinedaudiences$List; options = {}; } @@ -10202,106 +15541,59 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/combinedAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], - pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest< - Schema$ListLineItemAssignedTargetingOptionsResponse - >(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create - extends StandardParameters { - /** - * Required. The ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the line item the assigned targeting option will belong to. - */ - lineItemId?: string; - /** - * Required. Identifies the type of this assigned targeting option. - */ - targetingType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AssignedTargetingOption; - } - export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete - extends StandardParameters { - /** - * Required. The ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the assigned targeting option to delete. - */ - assignedTargetingOptionId?: string; - /** - * Required. The ID of the line item the assigned targeting option belongs to. - */ - lineItemId?: string; - /** - * Required. Identifies the type of this assigned targeting option. - */ - targetingType?: string; - } - export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + export interface Params$Resource$Combinedaudiences$Get extends StandardParameters { /** - * Required. The ID of the advertiser the line item belongs to. + * The ID of the advertiser that has access to the fetched combined audience. */ advertiserId?: string; /** - * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. - */ - assignedTargetingOptionId?: string; - /** - * Required. The ID of the line item the assigned targeting option belongs to. + * Required. The ID of the combined audience to fetch. */ - lineItemId?: string; + combinedAudienceId?: string; /** - * Required. Identifies the type of this assigned targeting option. + * The ID of the partner that has access to the fetched combined audience. */ - targetingType?: string; + partnerId?: string; } - export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + export interface Params$Resource$Combinedaudiences$List extends StandardParameters { /** - * Required. The ID of the advertiser the line item belongs to. + * The ID of the advertiser that has access to the fetched combined audiences. */ advertiserId?: string; /** - * Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + * Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. */ filter?: string; /** - * Required. The ID of the line item to list assigned targeting options for. - */ - lineItemId?: string; - /** - * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. */ orderBy?: string; /** @@ -10309,24 +15601,24 @@ export namespace displayvideo_v1 { */ pageSize?: number; /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned. */ pageToken?: string; /** - * Required. Identifies the type of assigned targeting options to list. + * The ID of the partner that has access to the fetched combined audiences. */ - targetingType?: string; + partnerId?: string; } - export class Resource$Advertisers$Locationlists { + export class Resource$Customlists { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * displayvideo.advertisers.locationLists.get - * @desc Gets a location list. + * displayvideo.customLists.get + * @desc Gets a custom list. * @example * // Before running the sample: * // - Enable the API at: @@ -10350,20 +15642,19 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.locationLists.get({ - * // Required. The ID of the DV360 advertiser to which the fetched location list belongs. - * advertiserId: '[^/]+', - * // Required. The ID of the location list to fetch. - * locationListId: '[^/]+', + * const res = await displayvideo.customLists.get({ + * // The ID of the DV360 advertiser that has access to the fetched custom + * // lists. + * advertiserId: 'placeholder-value', + * // Required. The ID of the custom list to fetch. + * customListId: '[^/]+', * }); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", + * // "customListId": "my_customListId", * // "displayName": "my_displayName", - * // "locationListId": "my_locationListId", - * // "locationType": "my_locationType", * // "name": "my_name" * // } * } @@ -10373,60 +15664,59 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.locationLists.get + * @alias displayvideo.customLists.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched location list belongs. - * @param {string} params.locationListId Required. The ID of the location list to fetch. + * @param {string=} params.advertiserId The ID of the DV360 advertiser that has access to the fetched custom lists. + * @param {string} params.customListId Required. The ID of the custom list to fetch. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params: Params$Resource$Advertisers$Locationlists$Get, + params: Params$Resource$Customlists$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Advertisers$Locationlists$Get, + params?: Params$Resource$Customlists$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Advertisers$Locationlists$Get, + params: Params$Resource$Customlists$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Locationlists$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Customlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Locationlists$Get, - callback: BodyResponseCallback + params: Params$Resource$Customlists$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Advertisers$Locationlists$Get - | BodyResponseCallback + | Params$Resource$Customlists$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Locationlists$Get; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customlists$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Locationlists$Get; + params = {} as Params$Resource$Customlists$Get; options = {}; } @@ -10439,32 +15729,32 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/locationLists/{+locationListId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/customLists/{+customListId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options ), params, - requiredParams: ['advertiserId', 'locationListId'], - pathParams: ['advertiserId', 'locationListId'], + requiredParams: ['customListId'], + pathParams: ['customListId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.locationLists.list - * @desc Lists location lists based on a given advertiser id. + * displayvideo.customLists.list + * @desc Lists custom lists. The order is defined by the order_by parameter. * @example * // Before running the sample: * // - Enable the API at: @@ -10488,47 +15778,46 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.locationLists.list({ - * // Required. The ID of the DV360 advertiser to which the fetched location lists belong. - * advertiserId: '[^/]+', - * // Allows filtering by location list fields. + * const res = await displayvideo.customLists.list({ + * // The ID of the DV360 advertiser that has access to the fetched custom + * // lists. + * advertiserId: 'placeholder-value', + * // Allows filtering by custom list fields. * // * // Supported syntax: * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by `AND` or `OR` logical operators. A - * // sequence of restrictions implicitly uses `AND`. + * // * Filter expressions for custom lists currently can only contain at + * // most one restriction. * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)`. + * // * The operator must be `CONTAINS (:)`. * // * Supported fields: - * // - `locationType` + * // - `displayName` * // * // Examples: * // - * // * All regional location list: - * // `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` - * // * All proximity location list: - * // `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + * // * All custom lists for which the display name contains "Google": + * // `displayName : "Google"`. + * // + * // The length of this field should be no more than 500 characters. * filter: 'placeholder-value', * // Field by which to sort the list. * // Acceptable values are: * // - * // * `locationListId` (default) + * // * `customListId` (default) * // * `displayName` * // * // The default sorting order is ascending. To specify descending order for * // a field, a suffix "desc" should be added to the field name. Example: * // `displayName desc`. * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. - * // Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an - * // invalid value is specified. + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. - * // * // Typically, this is the value of * // next_page_token - * // returned from the previous call to `ListLocationLists` method. + * // returned from the previous call to `ListCustomLists` method. * // If not specified, the first page of results will be returned. * pageToken: 'placeholder-value', * }); @@ -10536,7 +15825,7 @@ export namespace displayvideo_v1 { * * // Example response * // { - * // "locationLists": [], + * // "customLists": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -10546,70 +15835,67 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.locationLists.list + * @alias displayvideo.customLists.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched location lists belong. - * @param {string=} params.filter Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned. + * @param {string=} params.advertiserId The ID of the DV360 advertiser that has access to the fetched custom lists. + * @param {string=} params.filter Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params: Params$Resource$Advertisers$Locationlists$List, + params: Params$Resource$Customlists$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Advertisers$Locationlists$List, + params?: Params$Resource$Customlists$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Advertisers$Locationlists$List, + params: Params$Resource$Customlists$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Locationlists$List, + params: Params$Resource$Customlists$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$Locationlists$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Customlists$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Locationlists$List - | BodyResponseCallback + | Params$Resource$Customlists$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Locationlists$List; + let params = (paramsOrCallback || {}) as Params$Resource$Customlists$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Locationlists$List; + params = {} as Params$Resource$Customlists$List; options = {}; } @@ -10622,73 +15908,69 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/advertisers/{+advertiserId}/locationLists' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/customLists').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Advertisers$Locationlists$Get - extends StandardParameters { + export interface Params$Resource$Customlists$Get extends StandardParameters { /** - * Required. The ID of the DV360 advertiser to which the fetched location list belongs. + * The ID of the DV360 advertiser that has access to the fetched custom lists. */ advertiserId?: string; /** - * Required. The ID of the location list to fetch. + * Required. The ID of the custom list to fetch. */ - locationListId?: string; + customListId?: string; } - export interface Params$Resource$Advertisers$Locationlists$List - extends StandardParameters { + export interface Params$Resource$Customlists$List extends StandardParameters { /** - * Required. The ID of the DV360 advertiser to which the fetched location lists belong. + * The ID of the DV360 advertiser that has access to the fetched custom lists. */ advertiserId?: string; /** - * Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + * Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. */ filter?: string; /** - * Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. */ orderBy?: string; /** - * Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */ pageSize?: number; /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned. + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned. */ pageToken?: string; } - export class Resource$Advertisers$Negativekeywordlists { + export class Resource$Firstandthirdpartyaudiences { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * displayvideo.advertisers.negativeKeywordLists.get - * @desc Gets a negative keyword list given an advertiser ID and a negative keyword list ID. + * displayvideo.firstAndThirdPartyAudiences.get + * @desc Gets a first and third party audience. * @example * // Before running the sample: * // - Enable the API at: @@ -10712,21 +15994,24 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.negativeKeywordLists.get({ - * // Required. The ID of the DV360 advertiser to which the fetched negative keyword list - * // belongs. - * advertiserId: '[^/]+', - * // Required. The ID of the negative keyword list to fetch. - * negativeKeywordListId: '[^/]+', + * const res = await displayvideo.firstAndThirdPartyAudiences.get({ + * // The ID of the advertiser that has access to the fetched first and + * // third party audience. + * advertiserId: 'placeholder-value', + * // Required. The ID of the first and third party audience to fetch. + * firstAndThirdPartyAudienceId: '[^/]+', + * // The ID of the partner that has access to the fetched first and + * // third party audience. + * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", * // "displayName": "my_displayName", - * // "name": "my_name", - * // "negativeKeywordListId": "my_negativeKeywordListId" + * // "firstAndThirdPartyAudienceId": "my_firstAndThirdPartyAudienceId", + * // "firstAndThirdPartyAudienceType": "my_firstAndThirdPartyAudienceType", + * // "name": "my_name" * // } * } * @@ -10735,63 +16020,68 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.negativeKeywordLists.get + * @alias displayvideo.firstAndThirdPartyAudiences.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. - * @param {string} params.negativeKeywordListId Required. The ID of the negative keyword list to fetch. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched first and third party audience. + * @param {string} params.firstAndThirdPartyAudienceId Required. The ID of the first and third party audience to fetch. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched first and third party audience. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params: Params$Resource$Advertisers$Negativekeywordlists$Get, + params: Params$Resource$Firstandthirdpartyaudiences$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Advertisers$Negativekeywordlists$Get, + params?: Params$Resource$Firstandthirdpartyaudiences$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Advertisers$Negativekeywordlists$Get, + params: Params$Resource$Firstandthirdpartyaudiences$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Negativekeywordlists$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Firstandthirdpartyaudiences$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Negativekeywordlists$Get, - callback: BodyResponseCallback + params: Params$Resource$Firstandthirdpartyaudiences$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Advertisers$Negativekeywordlists$Get - | BodyResponseCallback + | Params$Resource$Firstandthirdpartyaudiences$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Negativekeywordlists$Get; + {}) as Params$Resource$Firstandthirdpartyaudiences$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Negativekeywordlists$Get; + params = {} as Params$Resource$Firstandthirdpartyaudiences$Get; options = {}; } @@ -10806,30 +16096,30 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}' + '/v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['advertiserId', 'negativeKeywordListId'], - pathParams: ['advertiserId', 'negativeKeywordListId'], + requiredParams: ['firstAndThirdPartyAudienceId'], + pathParams: ['firstAndThirdPartyAudienceId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.negativeKeywordLists.list - * @desc Lists negative keyword lists based on a given advertiser id. + * displayvideo.firstAndThirdPartyAudiences.list + * @desc Lists first and third party audiences. The order is defined by the order_by parameter. * @example * // Before running the sample: * // - Enable the API at: @@ -10853,27 +16143,57 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.negativeKeywordLists.list({ - * // Required. The ID of the DV360 advertiser to which the fetched negative keyword lists - * // belong. - * advertiserId: '[^/]+', - * // Requested page size. Must be between `1` and `100`. - * // Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an - * // invalid value is specified. + * const res = await displayvideo.firstAndThirdPartyAudiences.list({ + * // The ID of the advertiser that has access to the fetched first and + * // third party audiences. + * advertiserId: 'placeholder-value', + * // Allows filtering by first and third party audience fields. + * // + * // Supported syntax: + * // + * // * Filter expressions for first and third party audiences currently can + * // only contain at most one restriction. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `CONTAINS (:)`. + * // * Supported fields: + * // - `displayName` + * // + * // Examples: + * // + * // * All first and third party audiences for which the display name contains + * // "Google": `displayName : "Google"`. + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `firstAndThirdPartyAudienceId` (default) + * // * `displayName` + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. - * // * // Typically, this is the value of * // next_page_token - * // returned from the previous call to `ListNegativeKeywordLists` method. - * // If not specified, the first page of results will be returned. + * // returned from the previous call to `ListFirstAndThirdPartyAudiences` + * // method. If not specified, the first page of results will be returned. * pageToken: 'placeholder-value', + * // The ID of the partner that has access to the fetched first and + * // third party audiences. + * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "negativeKeywordLists": [], + * // "firstAndThirdPartyAudiences": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -10883,68 +16203,77 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.negativeKeywordLists.list + * @alias displayvideo.firstAndThirdPartyAudiences.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched first and third party audiences. + * @param {string=} params.filter Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched first and third party audiences. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params: Params$Resource$Advertisers$Negativekeywordlists$List, + params: Params$Resource$Firstandthirdpartyaudiences$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Advertisers$Negativekeywordlists$List, + params?: Params$Resource$Firstandthirdpartyaudiences$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Advertisers$Negativekeywordlists$List, + params: Params$Resource$Firstandthirdpartyaudiences$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Negativekeywordlists$List, + params: Params$Resource$Firstandthirdpartyaudiences$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListFirstAndThirdPartyAudiencesResponse + > ): void; list( - params: Params$Resource$Advertisers$Negativekeywordlists$List, - callback: BodyResponseCallback + params: Params$Resource$Firstandthirdpartyaudiences$List, + callback: BodyResponseCallback< + Schema$ListFirstAndThirdPartyAudiencesResponse + > ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback< + Schema$ListFirstAndThirdPartyAudiencesResponse + > ): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Negativekeywordlists$List - | BodyResponseCallback + | Params$Resource$Firstandthirdpartyaudiences$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Negativekeywordlists$List; + {}) as Params$Resource$Firstandthirdpartyaudiences$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Negativekeywordlists$List; + params = {} as Params$Resource$Firstandthirdpartyaudiences$List; options = {}; } @@ -10957,202 +16286,124 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/advertisers/{+advertiserId}/negativeKeywordLists' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/firstAndThirdPartyAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Advertisers$Negativekeywordlists$Get + export interface Params$Resource$Firstandthirdpartyaudiences$Get extends StandardParameters { /** - * Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. + * The ID of the advertiser that has access to the fetched first and third party audience. */ advertiserId?: string; /** - * Required. The ID of the negative keyword list to fetch. + * Required. The ID of the first and third party audience to fetch. */ - negativeKeywordListId?: string; + firstAndThirdPartyAudienceId?: string; + /** + * The ID of the partner that has access to the fetched first and third party audience. + */ + partnerId?: string; } - export interface Params$Resource$Advertisers$Negativekeywordlists$List + export interface Params$Resource$Firstandthirdpartyaudiences$List extends StandardParameters { /** - * Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. + * The ID of the advertiser that has access to the fetched first and third party audiences. */ advertiserId?: string; /** - * Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */ pageSize?: number; /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned. */ pageToken?: string; + /** + * The ID of the partner that has access to the fetched first and third party audiences. + */ + partnerId?: string; } - export class Resource$Advertisers$Targetingtypes { - context: APIRequestContext; - assignedTargetingOptions: Resource$Advertisers$Targetingtypes$Assignedtargetingoptions; - constructor(context: APIRequestContext) { - this.context = context; - this.assignedTargetingOptions = new Resource$Advertisers$Targetingtypes$Assignedtargetingoptions( - this.context - ); - } - } - - export class Resource$Advertisers$Targetingtypes$Assignedtargetingoptions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create - * @desc Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create( - * { - * // Required. The ID of the advertiser. - * advertiserId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. - * targetingType: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "audienceGroupDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "negativeKeywordListDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {} - * // } - * }, - * } - * ); + export class Resource$Floodlightgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.floodlightGroups.get + * @desc Gets a Floodlight group. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.floodlightGroups.get({ + * // Required. The ID of the Floodlight group to fetch. + * floodlightGroupId: '[^/]+', + * // Required. The partner context by which the Floodlight group is being accessed. + * partnerId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "audienceGroupDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, + * // "activeViewConfig": {}, + * // "customVariables": {}, + * // "displayName": "my_displayName", + * // "floodlightGroupId": "my_floodlightGroupId", + * // "lookbackWindow": {}, * // "name": "my_name", - * // "negativeKeywordListDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {} + * // "webTagType": "my_webTagType" * // } * } * @@ -11161,68 +16412,60 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create + * @alias displayvideo.floodlightGroups.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser. - * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. - * @param {().AssignedTargetingOption} params.requestBody Request body data + * @param {string} params.floodlightGroupId Required. The ID of the Floodlight group to fetch. + * @param {string=} params.partnerId Required. The partner context by which the Floodlight group is being accessed. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + get( + params: Params$Resource$Floodlightgroups$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + get( + params?: Params$Resource$Floodlightgroups$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Floodlightgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Floodlightgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + params: Params$Resource$Floodlightgroups$Get, + callback: BodyResponseCallback ): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create - | BodyResponseCallback + | Params$Resource$Floodlightgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create; + {}) as Params$Resource$Floodlightgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create; + params = {} as Params$Resource$Floodlightgroups$Get; options = {}; } @@ -11236,31 +16479,30 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + rootUrl + '/v1/floodlightGroups/{+floodlightGroupId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['advertiserId', 'targetingType'], - pathParams: ['advertiserId', 'targetingType'], + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete - * @desc Deletes an assigned targeting option from an advertiser. + * displayvideo.floodlightGroups.patch + * @desc Updates an existing Floodlight group. Returns the updated Floodlight group if successful. * @example * // Before running the sample: * // - Enable the API at: @@ -11284,20 +16526,40 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete( - * { - * // Required. The ID of the advertiser. - * advertiserId: '[^/]+', - * // Required. The ID of the assigned targeting option to delete. - * assignedTargetingOptionId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. - * targetingType: '[^/]+', - * } - * ); + * const res = await displayvideo.floodlightGroups.patch({ + * // Output only. The unique ID of the Floodlight group. Assigned by the system. + * floodlightGroupId: 'placeholder-value', + * // Required. The partner context by which the Floodlight group is being accessed. + * partnerId: 'placeholder-value', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "activeViewConfig": {}, + * // "customVariables": {}, + * // "displayName": "my_displayName", + * // "floodlightGroupId": "my_floodlightGroupId", + * // "lookbackWindow": {}, + * // "name": "my_name", + * // "webTagType": "my_webTagType" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "activeViewConfig": {}, + * // "customVariables": {}, + * // "displayName": "my_displayName", + * // "floodlightGroupId": "my_floodlightGroupId", + * // "lookbackWindow": {}, + * // "name": "my_name", + * // "webTagType": "my_webTagType" + * // } * } * * main().catch(e => { @@ -11305,61 +16567,62 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete + * @alias displayvideo.floodlightGroups.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser. - * @param {string} params.assignedTargetingOptionId Required. The ID of the assigned targeting option to delete. - * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {string} params.floodlightGroupId Output only. The unique ID of the Floodlight group. Assigned by the system. + * @param {string=} params.partnerId Required. The partner context by which the Floodlight group is being accessed. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().FloodlightGroup} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + patch( + params: Params$Resource$Floodlightgroups$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + patch( + params?: Params$Resource$Floodlightgroups$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Floodlightgroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Floodlightgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Floodlightgroups$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete - | BodyResponseCallback + | Params$Resource$Floodlightgroups$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete; + {}) as Params$Resource$Floodlightgroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete; + params = {} as Params$Resource$Floodlightgroups$Patch; options = {}; } @@ -11372,40 +16635,71 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/floodlightGroups/{floodlightGroupId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', }, options ), params, - requiredParams: [ - 'advertiserId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'targetingType', - ], + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Floodlightgroups$Get + extends StandardParameters { /** - * displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get - * @desc Gets a single targeting option assigned to an advertiser. + * Required. The ID of the Floodlight group to fetch. + */ + floodlightGroupId?: string; + /** + * Required. The partner context by which the Floodlight group is being accessed. + */ + partnerId?: string; + } + export interface Params$Resource$Floodlightgroups$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the Floodlight group. Assigned by the system. + */ + floodlightGroupId?: string; + /** + * Required. The partner context by which the Floodlight group is being accessed. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightGroup; + } + + export class Resource$Googleaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.googleAudiences.get + * @desc Gets a Google audience. * @example * // Before running the sample: * // - Enable the API at: @@ -11429,62 +16723,22 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get( - * { - * // Required. The ID of the advertiser. - * advertiserId: '[^/]+', - * // Required. An identifier unique to the targeting type in this advertiser that - * // identifies the assigned targeting option being requested. - * assignedTargetingOptionId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. - * targetingType: '[^/]+', - * } - * ); + * const res = await displayvideo.googleAudiences.get({ + * // The ID of the advertiser that has access to the fetched Google audience. + * advertiserId: 'placeholder-value', + * // Required. The ID of the Google audience to fetch. + * googleAudienceId: '[^/]+', + * // The ID of the partner that has access to the fetched Google audience. + * partnerId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "audienceGroupDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "negativeKeywordListDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {} + * // "displayName": "my_displayName", + * // "googleAudienceId": "my_googleAudienceId", + * // "googleAudienceType": "my_googleAudienceType", + * // "name": "my_name" * // } * } * @@ -11493,66 +16747,61 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get + * @alias displayvideo.googleAudiences.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser. - * @param {string} params.assignedTargetingOptionId Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. - * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched Google audience. + * @param {string} params.googleAudienceId Required. The ID of the Google audience to fetch. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched Google audience. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + params: Params$Resource$Googleaudiences$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + params?: Params$Resource$Googleaudiences$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + params: Params$Resource$Googleaudiences$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Googleaudiences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, - callback: BodyResponseCallback + params: Params$Resource$Googleaudiences$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get - | BodyResponseCallback + | Params$Resource$Googleaudiences$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get; + {}) as Params$Resource$Googleaudiences$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get; + params = {} as Params$Resource$Googleaudiences$Get; options = {}; } @@ -11565,40 +16814,32 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/googleAudiences/{+googleAudienceId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options ), params, - requiredParams: [ - 'advertiserId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'targetingType', - ], + requiredParams: ['googleAudienceId'], + pathParams: ['googleAudienceId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list - * @desc Lists the targeting options assigned to an advertiser. + * displayvideo.googleAudiences.list + * @desc Lists Google audiences. The order is defined by the order_by parameter. * @example * // Before running the sample: * // - Enable the API at: @@ -11622,56 +16863,55 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list( - * { - * // Required. The ID of the advertiser. - * advertiserId: '[^/]+', - * // Allows filtering by assigned targeting option properties. - * // - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by the logical operator `OR`. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)`. - * // * Supported fields: - * // - `assignedTargetingOptionId` - * // - * // Examples: - * // - * // * AssignedTargetingOption with ID 123456 - * // `assignedTargetingOptionId="123456"` - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Field by which to sort the list. - * // Acceptable values are: - * // - * // * `assignedTargetingOptionId` (default) - * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `assignedTargetingOptionId desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - * // is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListAdvertiserAssignedTargetingOptions` - * // method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // Required. Identifies the type of assigned targeting options to list. - * targetingType: '[^/]+', - * } - * ); + * const res = await displayvideo.googleAudiences.list({ + * // The ID of the advertiser that has access to the fetched Google audiences. + * advertiserId: 'placeholder-value', + * // Allows filtering by Google audience fields. + * // + * // Supported syntax: + * // + * // * Filter expressions for Google audiences currently can only contain at + * // most one restriction. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `CONTAINS (:)`. + * // * Supported fields: + * // - `displayName` + * // + * // Examples: + * // + * // * All Google audiences for which the display name contains "Google": + * // `displayName : "Google"`. + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `googleAudienceId` (default) + * // * `displayName` + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. Example: + * // `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListGoogleAudiences` method. + * // If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // The ID of the partner that has access to the fetched Google audiences. + * partnerId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], + * // "googleAudiences": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -11681,85 +16921,71 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list + * @alias displayvideo.googleAudiences.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.advertiserId Required. The ID of the advertiser. - * @param {string=} params.filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched Google audiences. + * @param {string=} params.filter Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * @param {string} params.targetingType Required. Identifies the type of assigned targeting options to list. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched Google audiences. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Googleaudiences$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + params?: Params$Resource$Googleaudiences$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Googleaudiences$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Googleaudiences$List, options: | MethodOptions - | BodyResponseCallback< - Schema$ListAdvertiserAssignedTargetingOptionsResponse - >, - callback: BodyResponseCallback< - Schema$ListAdvertiserAssignedTargetingOptionsResponse - > + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, - callback: BodyResponseCallback< - Schema$ListAdvertiserAssignedTargetingOptionsResponse - > + params: Params$Resource$Googleaudiences$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback< - Schema$ListAdvertiserAssignedTargetingOptionsResponse - > + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List - | BodyResponseCallback< - Schema$ListAdvertiserAssignedTargetingOptionsResponse - > + | Params$Resource$Googleaudiences$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback< - Schema$ListAdvertiserAssignedTargetingOptionsResponse - > + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback< - Schema$ListAdvertiserAssignedTargetingOptionsResponse - > + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List; + {}) as Params$Resource$Googleaudiences$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List; + params = {} as Params$Resource$Googleaudiences$List; options = {}; } @@ -11772,90 +16998,57 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/googleAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options ), params, - requiredParams: ['advertiserId', 'targetingType'], - pathParams: ['advertiserId', 'targetingType'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest< - Schema$ListAdvertiserAssignedTargetingOptionsResponse - >(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create - extends StandardParameters { - /** - * Required. The ID of the advertiser. - */ - advertiserId?: string; - /** - * Required. Identifies the type of this assigned targeting option. - */ - targetingType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AssignedTargetingOption; - } - export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete - extends StandardParameters { - /** - * Required. The ID of the advertiser. - */ - advertiserId?: string; - /** - * Required. The ID of the assigned targeting option to delete. - */ - assignedTargetingOptionId?: string; - /** - * Required. Identifies the type of this assigned targeting option. - */ - targetingType?: string; - } - export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get + export interface Params$Resource$Googleaudiences$Get extends StandardParameters { /** - * Required. The ID of the advertiser. + * The ID of the advertiser that has access to the fetched Google audience. */ advertiserId?: string; /** - * Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. + * Required. The ID of the Google audience to fetch. */ - assignedTargetingOptionId?: string; + googleAudienceId?: string; /** - * Required. Identifies the type of this assigned targeting option. + * The ID of the partner that has access to the fetched Google audience. */ - targetingType?: string; + partnerId?: string; } - export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List + export interface Params$Resource$Googleaudiences$List extends StandardParameters { /** - * Required. The ID of the advertiser. + * The ID of the advertiser that has access to the fetched Google audiences. */ advertiserId?: string; /** - * Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. + * Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. */ filter?: string; /** - * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. */ orderBy?: string; /** @@ -11863,24 +17056,186 @@ export namespace displayvideo_v1 { */ pageSize?: number; /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned. */ pageToken?: string; /** - * Required. Identifies the type of assigned targeting options to list. + * The ID of the partner that has access to the fetched Google audiences. */ - targetingType?: string; + partnerId?: string; } - export class Resource$Combinedaudiences { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + export class Resource$Inventorysourcegroups { + context: APIRequestContext; + assignedInventorySources: Resource$Inventorysourcegroups$Assignedinventorysources; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedInventorySources = new Resource$Inventorysourcegroups$Assignedinventorysources( + this.context + ); + } + + /** + * displayvideo.inventorySourceGroups.create + * @desc Creates a new inventory source group. Returns the newly created inventory source group if successful. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.inventorySourceGroups.create({ + * // The ID of the advertiser that owns the inventory source group. + * // + * // The parent partner will not have access to this group. + * advertiserId: 'placeholder-value', + * // The ID of the partner that owns the inventory source group. + * // + * // Only this partner will have write access to this group. Only advertisers + * // to which this group is explicitly shared will have read access to this + * // group. + * partnerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName", + * // "inventorySourceGroupId": "my_inventorySourceGroupId", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "inventorySourceGroupId": "my_inventorySourceGroupId", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.inventorySourceGroups.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group. + * @param {string=} params.partnerId The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group. + * @param {().InventorySourceGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params: Params$Resource$Inventorysourcegroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Inventorysourcegroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Inventorysourcegroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/inventorySourceGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } } /** - * displayvideo.combinedAudiences.get - * @desc Gets a combined audience. + * displayvideo.inventorySourceGroups.delete + * @desc Deletes an inventory source group. * @example * // Before running the sample: * // - Enable the API at: @@ -11904,23 +17259,22 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.combinedAudiences.get({ - * // The ID of the advertiser that has access to the fetched combined - * // audience. + * const res = await displayvideo.inventorySourceGroups.delete({ + * // The ID of the advertiser that owns the inventory source group. + * // + * // The parent partner does not have access to this group. * advertiserId: 'placeholder-value', - * // Required. The ID of the combined audience to fetch. - * combinedAudienceId: '[^/]+', - * // The ID of the partner that has access to the fetched combined audience. + * // Required. The ID of the inventory source group to delete. + * inventorySourceGroupId: '[^/]+', + * // The ID of the partner that owns the inventory source group. + * // + * // Only this partner has write access to this group. * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // { - * // "combinedAudienceId": "my_combinedAudienceId", - * // "displayName": "my_displayName", - * // "name": "my_name" - * // } + * // {} * } * * main().catch(e => { @@ -11928,61 +17282,61 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.combinedAudiences.get + * @alias displayvideo.inventorySourceGroups.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched combined audience. - * @param {string} params.combinedAudienceId Required. The ID of the combined audience to fetch. - * @param {string=} params.partnerId The ID of the partner that has access to the fetched combined audience. + * @param {string=} params.advertiserId The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. + * @param {string} params.inventorySourceGroupId Required. The ID of the inventory source group to delete. + * @param {string=} params.partnerId The ID of the partner that owns the inventory source group. Only this partner has write access to this group. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Combinedaudiences$Get, + delete( + params: Params$Resource$Inventorysourcegroups$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Combinedaudiences$Get, + delete( + params?: Params$Resource$Inventorysourcegroups$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Combinedaudiences$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Inventorysourcegroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Combinedaudiences$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Combinedaudiences$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Combinedaudiences$Get - | BodyResponseCallback + | Params$Resource$Inventorysourcegroups$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Combinedaudiences$Get; + {}) as Params$Resource$Inventorysourcegroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Combinedaudiences$Get; + params = {} as Params$Resource$Inventorysourcegroups$Delete; options = {}; } @@ -11996,30 +17350,30 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/combinedAudiences/{+combinedAudienceId}' + rootUrl + '/v1/inventorySourceGroups/{+inventorySourceGroupId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), params, - requiredParams: ['combinedAudienceId'], - pathParams: ['combinedAudienceId'], + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.combinedAudiences.list - * @desc Lists combined audiences. The order is defined by the order_by parameter. + * displayvideo.inventorySourceGroups.get + * @desc Gets an inventory source group. * @example * // Before running the sample: * // - Enable the API at: @@ -12043,57 +17397,26 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.combinedAudiences.list({ - * // The ID of the advertiser that has access to the fetched combined - * // audiences. - * advertiserId: 'placeholder-value', - * // Allows filtering by combined audience fields. - * // - * // Supported syntax: - * // - * // * Filter expressions for combined audiences currently can only contain at - * // most one restriction. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `CONTAINS (:)`. - * // * Supported fields: - * // - `displayName` - * // - * // Examples: - * // - * // * All combined audiences for which the display name contains "Google": - * // `displayName : "Google"`. - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Field by which to sort the list. - * // Acceptable values are: + * const res = await displayvideo.inventorySourceGroups.get({ + * // The ID of the advertiser that has access to the inventory source group. * // - * // * `combinedAudienceId` (default) - * // * `displayName` + * // If an inventory source group is partner-owned, only advertisers to which + * // the group is explicitly shared can access the group. + * advertiserId: 'placeholder-value', + * // Required. The ID of the inventory source group to fetch. + * inventorySourceGroupId: '[^/]+', + * // The ID of the partner that has access to the inventory source group. * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - * // is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListCombinedAudiences` method. - * // If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // The ID of the partner that has access to the fetched combined audiences. + * // A partner cannot access an advertiser-owned inventory source group. * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "combinedAudiences": [], - * // "nextPageToken": "my_nextPageToken" + * // "displayName": "my_displayName", + * // "inventorySourceGroupId": "my_inventorySourceGroupId", + * // "name": "my_name" * // } * } * @@ -12102,71 +17425,66 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.combinedAudiences.list + * @alias displayvideo.inventorySourceGroups.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched combined audiences. - * @param {string=} params.filter Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned. - * @param {string=} params.partnerId The ID of the partner that has access to the fetched combined audiences. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + * @param {string} params.inventorySourceGroupId Required. The ID of the inventory source group to fetch. + * @param {string=} params.partnerId The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params: Params$Resource$Combinedaudiences$List, + get( + params: Params$Resource$Inventorysourcegroups$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Combinedaudiences$List, + get( + params?: Params$Resource$Inventorysourcegroups$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Combinedaudiences$List, + ): GaxiosPromise; + get( + params: Params$Resource$Inventorysourcegroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Combinedaudiences$List, + get( + params: Params$Resource$Inventorysourcegroups$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Combinedaudiences$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Inventorysourcegroups$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Combinedaudiences$List - | BodyResponseCallback + | Params$Resource$Inventorysourcegroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Combinedaudiences$List; + {}) as Params$Resource$Inventorysourcegroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Combinedaudiences$List; + params = {} as Params$Resource$Inventorysourcegroups$Get; options = {}; } @@ -12179,84 +17497,31 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/combinedAudiences').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/inventorySourceGroups/{+inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Combinedaudiences$Get - extends StandardParameters { - /** - * The ID of the advertiser that has access to the fetched combined audience. - */ - advertiserId?: string; - /** - * Required. The ID of the combined audience to fetch. - */ - combinedAudienceId?: string; - /** - * The ID of the partner that has access to the fetched combined audience. - */ - partnerId?: string; - } - export interface Params$Resource$Combinedaudiences$List - extends StandardParameters { - /** - * The ID of the advertiser that has access to the fetched combined audiences. - */ - advertiserId?: string; - /** - * Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * The ID of the partner that has access to the fetched combined audiences. - */ - partnerId?: string; - } - - export class Resource$Customlists { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * displayvideo.customLists.get - * @desc Gets a custom list. + * displayvideo.inventorySourceGroups.list + * @desc Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter. * @example * // Before running the sample: * // - Enable the API at: @@ -12280,20 +17545,55 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.customLists.get({ - * // The ID of the DV360 advertiser that has access to the fetched custom - * // lists. + * const res = await displayvideo.inventorySourceGroups.list({ + * // The ID of the advertiser that has access to the inventory source group. + * // + * // If an inventory source group is partner-owned, only advertisers to which + * // the group is explicitly shared can access the group. * advertiserId: 'placeholder-value', - * // Required. The ID of the custom list to fetch. - * customListId: '[^/]+', + * // Allows filtering by inventory source group properties. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by the logical operator `OR`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `inventorySourceGroupId` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `displayName` (default) + * // * `inventorySourceGroupId` + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. For example, + * // `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListInventorySources` method. + * // If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // The ID of the partner that has access to the inventory source group. + * // + * // A partner cannot access advertiser-owned inventory source groups. + * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "customListId": "my_customListId", - * // "displayName": "my_displayName", - * // "name": "my_name" + * // "inventorySourceGroups": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -12302,59 +17602,71 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.customLists.get + * @alias displayvideo.inventorySourceGroups.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the DV360 advertiser that has access to the fetched custom lists. - * @param {string} params.customListId Required. The ID of the custom list to fetch. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + * @param {string=} params.filter Allows filtering by inventory source group properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Customlists$Get, + list( + params: Params$Resource$Inventorysourcegroups$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Customlists$Get, + list( + params?: Params$Resource$Inventorysourcegroups$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Customlists$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysourcegroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Customlists$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Inventorysourcegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Customlists$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Inventorysourcegroups$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Customlists$Get - | BodyResponseCallback + | Params$Resource$Inventorysourcegroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Customlists$Get; + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Customlists$Get; + params = {} as Params$Resource$Inventorysourcegroups$List; options = {}; } @@ -12367,7 +17679,7 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/customLists/{+customListId}').replace( + url: (rootUrl + '/v1/inventorySourceGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -12376,23 +17688,25 @@ export namespace displayvideo_v1 { options ), params, - requiredParams: ['customListId'], - pathParams: ['customListId'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * displayvideo.customLists.list - * @desc Lists custom lists. The order is defined by the order_by parameter. + * displayvideo.inventorySourceGroups.patch + * @desc Updates an inventory source group. Returns the updated inventory source group if successful. * @example * // Before running the sample: * // - Enable the API at: @@ -12416,55 +17730,37 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.customLists.list({ - * // The ID of the DV360 advertiser that has access to the fetched custom - * // lists. - * advertiserId: 'placeholder-value', - * // Allows filtering by custom list fields. - * // - * // Supported syntax: - * // - * // * Filter expressions for custom lists currently can only contain at - * // most one restriction. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `CONTAINS (:)`. - * // * Supported fields: - * // - `displayName` - * // - * // Examples: - * // - * // * All custom lists for which the display name contains "Google": - * // `displayName : "Google"`. - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Field by which to sort the list. - * // Acceptable values are: + * const res = await displayvideo.inventorySourceGroups.patch({ + * // The ID of the advertiser that owns the inventory source group. * // - * // * `customListId` (default) - * // * `displayName` + * // The parent partner does not have access to this group. + * advertiserId: 'placeholder-value', + * // Output only. The unique ID of the inventory source group. Assigned by the system. + * inventorySourceGroupId: 'placeholder-value', + * // The ID of the partner that owns the inventory source group. * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - * // is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListCustomLists` method. - * // If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', + * // Only this partner has write access to this group. + * partnerId: 'placeholder-value', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName", + * // "inventorySourceGroupId": "my_inventorySourceGroupId", + * // "name": "my_name" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "customLists": [], - * // "nextPageToken": "my_nextPageToken" + * // "displayName": "my_displayName", + * // "inventorySourceGroupId": "my_inventorySourceGroupId", + * // "name": "my_name" * // } * } * @@ -12473,67 +17769,68 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.customLists.list + * @alias displayvideo.inventorySourceGroups.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the DV360 advertiser that has access to the fetched custom lists. - * @param {string=} params.filter Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned. + * @param {string=} params.advertiserId The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. + * @param {string} params.inventorySourceGroupId Output only. The unique ID of the inventory source group. Assigned by the system. + * @param {string=} params.partnerId The ID of the partner that owns the inventory source group. Only this partner has write access to this group. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().InventorySourceGroup} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params: Params$Resource$Customlists$List, + patch( + params: Params$Resource$Inventorysourcegroups$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Customlists$List, + patch( + params?: Params$Resource$Inventorysourcegroups$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Customlists$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Inventorysourcegroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Customlists$List, + patch( + params: Params$Resource$Inventorysourcegroups$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Customlists$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Inventorysourcegroups$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Customlists$List - | BodyResponseCallback + | Params$Resource$Inventorysourcegroups$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Customlists$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Customlists$List; + params = {} as Params$Resource$Inventorysourcegroups$Patch; options = {}; } @@ -12546,69 +17843,136 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/customLists').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1/inventorySourceGroups/{inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Customlists$Get extends StandardParameters { + export interface Params$Resource$Inventorysourcegroups$Create + extends StandardParameters { /** - * The ID of the DV360 advertiser that has access to the fetched custom lists. + * The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group. */ advertiserId?: string; /** - * Required. The ID of the custom list to fetch. + * The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group. */ - customListId?: string; + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySourceGroup; } - export interface Params$Resource$Customlists$List extends StandardParameters { + export interface Params$Resource$Inventorysourcegroups$Delete + extends StandardParameters { /** - * The ID of the DV360 advertiser that has access to the fetched custom lists. + * The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. */ advertiserId?: string; /** - * Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * Required. The ID of the inventory source group to delete. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to this group. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to fetch. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + */ + advertiserId?: string; + /** + * Allows filtering by inventory source group properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. */ orderBy?: string; /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. */ pageSize?: number; /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned. + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. */ pageToken?: string; + /** + * The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. + */ + partnerId?: string; } + export interface Params$Resource$Inventorysourcegroups$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the inventory source group. Assigned by the system. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to this group. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; - export class Resource$Firstandthirdpartyaudiences { + /** + * Request body metadata + */ + requestBody?: Schema$InventorySourceGroup; + } + + export class Resource$Inventorysourcegroups$Assignedinventorysources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * displayvideo.firstAndThirdPartyAudiences.get - * @desc Gets a first and third party audience. + * displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit + * @desc Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources. * @example * // Before running the sample: * // - Enable the API at: @@ -12632,23 +17996,200 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.firstAndThirdPartyAudiences.get({ - * // The ID of the advertiser that has access to the fetched first and - * // third party audience. - * advertiserId: 'placeholder-value', - * // Required. The ID of the first and third party audience to fetch. - * firstAndThirdPartyAudienceId: '[^/]+', - * // The ID of the partner that has access to the fetched first and - * // third party audience. - * partnerId: 'placeholder-value', + * const res = await displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit( + * { + * // Required. The ID of the inventory source group to which the assignments are + * // assigned. + * inventorySourceGroupId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "createdAssignedInventorySources": [], + * // "deletedAssignedInventorySources": [], + * // "partnerId": "my_partnerId" + * // } + * }, + * } + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "assignedInventorySources": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.inventorySourceGroupId Required. The ID of the inventory source group to which the assignments are assigned. + * @param {().BulkEditAssignedInventorySourcesRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$BulkEditAssignedInventorySourcesResponse + > + ): void; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + callback: BodyResponseCallback< + Schema$BulkEditAssignedInventorySourcesResponse + > + ): void; + bulkEdit( + callback: BodyResponseCallback< + Schema$BulkEditAssignedInventorySourcesResponse + > + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest< + Schema$BulkEditAssignedInventorySourcesResponse + >(parameters); + } + } + + /** + * displayvideo.inventorySourceGroups.assignedInventorySources.create + * @desc Creates an assignment between an inventory source and an inventory source group. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await displayvideo.inventorySourceGroups.assignedInventorySources.create( + * { + * // The ID of the advertiser that owns the parent inventory source group. + * // + * // The parent partner will not have access to this assigned inventory + * // source. + * advertiserId: 'placeholder-value', + * // Required. The ID of the inventory source group to which the assignment will be + * // assigned. + * inventorySourceGroupId: '[^/]+', + * // The ID of the partner that owns the parent inventory source group. + * // + * // Only this partner will have write access to this assigned inventory + * // source. + * partnerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "assignedInventorySourceId": "my_assignedInventorySourceId", + * // "inventorySourceId": "my_inventorySourceId", + * // "name": "my_name" + * // } + * }, + * } + * ); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "firstAndThirdPartyAudienceId": "my_firstAndThirdPartyAudienceId", - * // "firstAndThirdPartyAudienceType": "my_firstAndThirdPartyAudienceType", + * // "assignedInventorySourceId": "my_assignedInventorySourceId", + * // "inventorySourceId": "my_inventorySourceId", * // "name": "my_name" * // } * } @@ -12658,68 +18199,69 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.firstAndThirdPartyAudiences.get + * @alias displayvideo.inventorySourceGroups.assignedInventorySources.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched first and third party audience. - * @param {string} params.firstAndThirdPartyAudienceId Required. The ID of the first and third party audience to fetch. - * @param {string=} params.partnerId The ID of the partner that has access to the fetched first and third party audience. + * @param {string=} params.advertiserId The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source. + * @param {string} params.inventorySourceGroupId Required. The ID of the inventory source group to which the assignment will be assigned. + * @param {string=} params.partnerId The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source. + * @param {().AssignedInventorySource} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Firstandthirdpartyaudiences$Get, + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Firstandthirdpartyaudiences$Get, + create( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Firstandthirdpartyaudiences$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Firstandthirdpartyaudiences$Get, + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Firstandthirdpartyaudiences$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Firstandthirdpartyaudiences$Get - | BodyResponseCallback + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Firstandthirdpartyaudiences$Get; + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Firstandthirdpartyaudiences$Get; + params = {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create; options = {}; } @@ -12734,30 +18276,30 @@ export namespace displayvideo_v1 { { url: ( rootUrl + - '/v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}' + '/v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['firstAndThirdPartyAudienceId'], - pathParams: ['firstAndThirdPartyAudienceId'], + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.firstAndThirdPartyAudiences.list - * @desc Lists first and third party audiences. The order is defined by the order_by parameter. + * displayvideo.inventorySourceGroups.assignedInventorySources.delete + * @desc Deletes the assignment between an inventory source and an inventory source group. * @example * // Before running the sample: * // - Enable the API at: @@ -12781,59 +18323,27 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.firstAndThirdPartyAudiences.list({ - * // The ID of the advertiser that has access to the fetched first and - * // third party audiences. - * advertiserId: 'placeholder-value', - * // Allows filtering by first and third party audience fields. - * // - * // Supported syntax: - * // - * // * Filter expressions for first and third party audiences currently can - * // only contain at most one restriction. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `CONTAINS (:)`. - * // * Supported fields: - * // - `displayName` - * // - * // Examples: - * // - * // * All first and third party audiences for which the display name contains - * // "Google": `displayName : "Google"`. - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Field by which to sort the list. - * // Acceptable values are: - * // - * // * `firstAndThirdPartyAudienceId` (default) - * // * `displayName` - * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - * // is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListFirstAndThirdPartyAudiences` - * // method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // The ID of the partner that has access to the fetched first and - * // third party audiences. - * partnerId: 'placeholder-value', - * }); + * const res = await displayvideo.inventorySourceGroups.assignedInventorySources.delete( + * { + * // The ID of the advertiser that owns the parent inventory source group. + * // + * // The parent partner does not have access to this assigned inventory + * // source. + * advertiserId: 'placeholder-value', + * // Required. The ID of the assigned inventory source to delete. + * assignedInventorySourceId: '[^/]+', + * // Required. The ID of the inventory source group to which this assignment is assigned. + * inventorySourceGroupId: '[^/]+', + * // The ID of the partner that owns the parent inventory source group. + * // + * // Only this partner has write access to this assigned inventory source. + * partnerId: 'placeholder-value', + * } + * ); * console.log(res.data); * * // Example response - * // { - * // "firstAndThirdPartyAudiences": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -12841,77 +18351,62 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.firstAndThirdPartyAudiences.list + * @alias displayvideo.inventorySourceGroups.assignedInventorySources.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched first and third party audiences. - * @param {string=} params.filter Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned. - * @param {string=} params.partnerId The ID of the partner that has access to the fetched first and third party audiences. + * @param {string=} params.advertiserId The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source. + * @param {string} params.assignedInventorySourceId Required. The ID of the assigned inventory source to delete. + * @param {string} params.inventorySourceGroupId Required. The ID of the inventory source group to which this assignment is assigned. + * @param {string=} params.partnerId The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params: Params$Resource$Firstandthirdpartyaudiences$List, + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Firstandthirdpartyaudiences$List, + delete( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Firstandthirdpartyaudiences$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Firstandthirdpartyaudiences$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$ListFirstAndThirdPartyAudiencesResponse - > - ): void; - list( - params: Params$Resource$Firstandthirdpartyaudiences$List, - callback: BodyResponseCallback< - Schema$ListFirstAndThirdPartyAudiencesResponse - > + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback< - Schema$ListFirstAndThirdPartyAudiencesResponse - > + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Firstandthirdpartyaudiences$List - | BodyResponseCallback + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Firstandthirdpartyaudiences$List; + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Firstandthirdpartyaudiences$List; + params = {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete; options = {}; } @@ -12924,84 +18419,32 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/firstAndThirdPartyAudiences').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback<{} | void> - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Firstandthirdpartyaudiences$Get - extends StandardParameters { - /** - * The ID of the advertiser that has access to the fetched first and third party audience. - */ - advertiserId?: string; - /** - * Required. The ID of the first and third party audience to fetch. - */ - firstAndThirdPartyAudienceId?: string; - /** - * The ID of the partner that has access to the fetched first and third party audience. - */ - partnerId?: string; - } - export interface Params$Resource$Firstandthirdpartyaudiences$List - extends StandardParameters { - /** - * The ID of the advertiser that has access to the fetched first and third party audiences. - */ - advertiserId?: string; - /** - * Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * The ID of the partner that has access to the fetched first and third party audiences. - */ - partnerId?: string; - } - - export class Resource$Floodlightgroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + url: ( + rootUrl + + '/v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId', 'assignedInventorySourceId'], + pathParams: ['assignedInventorySourceId', 'inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback<{} | void> + ); + } else { + return createAPIRequest(parameters); + } } /** - * displayvideo.floodlightGroups.get - * @desc Gets a Floodlight group. + * displayvideo.inventorySourceGroups.assignedInventorySources.list + * @desc Lists inventory sources assigned to an inventory source group. * @example * // Before running the sample: * // - Enable the API at: @@ -13025,23 +18468,63 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.floodlightGroups.get({ - * // Required. The ID of the Floodlight group to fetch. - * floodlightGroupId: '[^/]+', - * // Required. The partner context by which the Floodlight group is being accessed. - * partnerId: 'placeholder-value', - * }); + * const res = await displayvideo.inventorySourceGroups.assignedInventorySources.list( + * { + * // The ID of the advertiser that has access to the assignment. + * // + * // If the parent inventory source group is partner-owned, only advertisers + * // to which the parent group is explicitly shared can access the assigned + * // inventory source. + * advertiserId: 'placeholder-value', + * // Allows filtering by assigned inventory source fields. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by the logical operator `OR`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `assignedInventorySourceId` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Required. The ID of the inventory source group to which these assignments are + * // assigned. + * inventorySourceGroupId: '[^/]+', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `assignedInventorySourceId` (default) + * // + * // The default sorting order is ascending. To specify descending order for a + * // field, a suffix " desc" should be added to the field name. Example: + * // `assignedInventorySourceId desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListAssignedInventorySources` + * // method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // The ID of the partner that has access to the assignment. + * // + * // If the parent inventory source group is advertiser-owned, the assignment + * // cannot be accessed via a partner. + * partnerId: 'placeholder-value', + * } + * ); * console.log(res.data); * * // Example response * // { - * // "activeViewConfig": {}, - * // "customVariables": {}, - * // "displayName": "my_displayName", - * // "floodlightGroupId": "my_floodlightGroupId", - * // "lookbackWindow": {}, - * // "name": "my_name", - * // "webTagType": "my_webTagType" + * // "assignedInventorySources": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -13050,60 +18533,78 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.floodlightGroups.get + * @alias displayvideo.inventorySourceGroups.assignedInventorySources.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.floodlightGroupId Required. The ID of the Floodlight group to fetch. - * @param {string=} params.partnerId Required. The partner context by which the Floodlight group is being accessed. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source. + * @param {string=} params.filter Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedInventorySourceId` The length of this field should be no more than 500 characters. + * @param {string} params.inventorySourceGroupId Required. The ID of the inventory source group to which these assignments are assigned. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Floodlightgroups$Get, + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Floodlightgroups$Get, + list( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Floodlightgroups$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Floodlightgroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListAssignedInventorySourcesResponse + > ): void; - get( - params: Params$Resource$Floodlightgroups$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + callback: BodyResponseCallback< + Schema$ListAssignedInventorySourcesResponse + > ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback< + Schema$ListAssignedInventorySourcesResponse + > + ): void; + list( paramsOrCallback?: - | Params$Resource$Floodlightgroups$Get - | BodyResponseCallback + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightgroups$Get; + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightgroups$Get; + params = {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$List; options = {}; } @@ -13117,30 +18618,123 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/floodlightGroups/{+floodlightGroupId}' + rootUrl + + '/v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['floodlightGroupId'], - pathParams: ['floodlightGroupId'], + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit + extends StandardParameters { /** - * displayvideo.floodlightGroups.patch - * @desc Updates an existing Floodlight group. Returns the updated Floodlight group if successful. + * Required. The ID of the inventory source group to which the assignments are assigned. + */ + inventorySourceGroupId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedInventorySourcesRequest; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to which the assignment will be assigned. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedInventorySource; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned inventory source to delete. + */ + assignedInventorySourceId?: string; + /** + * Required. The ID of the inventory source group to which this assignment is assigned. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source. + */ + advertiserId?: string; + /** + * Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedInventorySourceId` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Required. The ID of the inventory source group to which these assignments are assigned. + */ + inventorySourceGroupId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner. + */ + partnerId?: string; + } + + export class Resource$Inventorysources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.inventorySources.get + * @desc Gets an inventory source. * @example * // Before running the sample: * // - Enable the API at: @@ -13164,39 +18758,31 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.floodlightGroups.patch({ - * // Output only. The unique ID of the Floodlight group. Assigned by the system. - * floodlightGroupId: 'placeholder-value', - * // Required. The partner context by which the Floodlight group is being accessed. + * const res = await displayvideo.inventorySources.get({ + * // Required. The ID of the inventory source to fetch. + * inventorySourceId: '[^/]+', + * // Required. The ID of the DV360 partner to which the fetched inventory source + * // is permissioned. * partnerId: 'placeholder-value', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "activeViewConfig": {}, - * // "customVariables": {}, - * // "displayName": "my_displayName", - * // "floodlightGroupId": "my_floodlightGroupId", - * // "lookbackWindow": {}, - * // "name": "my_name", - * // "webTagType": "my_webTagType" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "activeViewConfig": {}, - * // "customVariables": {}, + * // "commitment": "my_commitment", + * // "creativeConfigs": [], + * // "dealId": "my_dealId", + * // "deliveryMethod": "my_deliveryMethod", * // "displayName": "my_displayName", - * // "floodlightGroupId": "my_floodlightGroupId", - * // "lookbackWindow": {}, + * // "exchange": "my_exchange", + * // "inventorySourceId": "my_inventorySourceId", + * // "inventorySourceType": "my_inventorySourceType", * // "name": "my_name", - * // "webTagType": "my_webTagType" + * // "publisherName": "my_publisherName", + * // "rateDetails": {}, + * // "status": {}, + * // "timeRange": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -13205,62 +18791,60 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.floodlightGroups.patch + * @alias displayvideo.inventorySources.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.floodlightGroupId Output only. The unique ID of the Floodlight group. Assigned by the system. - * @param {string=} params.partnerId Required. The partner context by which the Floodlight group is being accessed. - * @param {string=} params.updateMask Required. The mask to control which fields to update. - * @param {().FloodlightGroup} params.requestBody Request body data + * @param {string} params.inventorySourceId Required. The ID of the inventory source to fetch. + * @param {string=} params.partnerId Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - patch( - params: Params$Resource$Floodlightgroups$Patch, + get( + params: Params$Resource$Inventorysources$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Floodlightgroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Floodlightgroups$Patch, + get( + params?: Params$Resource$Inventorysources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Inventorysources$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Floodlightgroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Inventorysources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Floodlightgroups$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Inventorysources$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Floodlightgroups$Patch - | BodyResponseCallback + | Params$Resource$Inventorysources$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightgroups$Patch; + {}) as Params$Resource$Inventorysources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightgroups$Patch; + params = {} as Params$Resource$Inventorysources$Get; options = {}; } @@ -13273,71 +18857,31 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/floodlightGroups/{floodlightGroupId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PATCH', + url: ( + rootUrl + '/v1/inventorySources/{+inventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['floodlightGroupId'], - pathParams: ['floodlightGroupId'], + requiredParams: ['inventorySourceId'], + pathParams: ['inventorySourceId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Floodlightgroups$Get - extends StandardParameters { - /** - * Required. The ID of the Floodlight group to fetch. - */ - floodlightGroupId?: string; - /** - * Required. The partner context by which the Floodlight group is being accessed. - */ - partnerId?: string; - } - export interface Params$Resource$Floodlightgroups$Patch - extends StandardParameters { - /** - * Output only. The unique ID of the Floodlight group. Assigned by the system. - */ - floodlightGroupId?: string; - /** - * Required. The partner context by which the Floodlight group is being accessed. - */ - partnerId?: string; - /** - * Required. The mask to control which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightGroup; - } - - export class Resource$Googleaudiences { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * displayvideo.googleAudiences.get - * @desc Gets a Google audience. + * displayvideo.inventorySources.list + * @desc Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results. * @example * // Before running the sample: * // - Enable the API at: @@ -13361,22 +18905,61 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.googleAudiences.get({ - * // The ID of the advertiser that has access to the fetched Google audience. + * const res = await displayvideo.inventorySources.list({ + * // The ID of the advertiser that has access to the inventory source. * advertiserId: 'placeholder-value', - * // Required. The ID of the Google audience to fetch. - * googleAudienceId: '[^/]+', - * // The ID of the partner that has access to the fetched Google audience. + * // Allows filtering by inventory source properties. + * // + * // Supported syntax: + * // + * // * Filter expressions are made up of one or more restrictions. + * // * Restrictions can be combined by `AND` or `OR` logical operators. A + * // sequence of restrictions implicitly uses `AND`. + * // * A restriction has the form of `{field} {operator} {value}`. + * // * The operator must be `EQUALS (=)`. + * // * Supported fields: + * // - `status.entityStatus` + * // - `commitment` + * // - `deliveryMethod` + * // - `rateDetails.rateType` + * // - `exchange` + * // + * // Examples: + * // + * // * All active inventory sources: + * // `status.entityStatus="ENTITY_STATUS_ACTIVE"` + * // * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: + * // `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` + * // + * // The length of this field should be no more than 500 characters. + * filter: 'placeholder-value', + * // Field by which to sort the list. + * // Acceptable values are: + * // + * // * `displayName` (default) + * // + * // The default sorting order is ascending. To specify descending order for + * // a field, a suffix "desc" should be added to the field name. For example, + * // `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will + * // default to `100`. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. + * // Typically, this is the value of + * // next_page_token + * // returned from the previous call to `ListInventorySources` method. + * // If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // The ID of the partner that has access to the inventory source. * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "googleAudienceId": "my_googleAudienceId", - * // "googleAudienceType": "my_googleAudienceType", - * // "name": "my_name" + * // "inventorySources": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -13385,61 +18968,71 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.googleAudiences.get + * @alias displayvideo.inventorySources.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched Google audience. - * @param {string} params.googleAudienceId Required. The ID of the Google audience to fetch. - * @param {string=} params.partnerId The ID of the partner that has access to the fetched Google audience. + * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source. + * @param {string=} params.filter Allows filtering by inventory source properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `status.entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the inventory source. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Googleaudiences$Get, + list( + params: Params$Resource$Inventorysources$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Googleaudiences$Get, + list( + params?: Params$Resource$Inventorysources$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Googleaudiences$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Googleaudiences$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Inventorysources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Googleaudiences$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Inventorysources$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Googleaudiences$Get - | BodyResponseCallback + | Params$Resource$Inventorysources$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Googleaudiences$Get; + {}) as Params$Resource$Inventorysources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Googleaudiences$Get; + params = {} as Params$Resource$Inventorysources$List; options = {}; } @@ -13452,7 +19045,7 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/googleAudiences/{+googleAudienceId}').replace( + url: (rootUrl + '/v1/inventorySources').replace( /([^:]\/)\/+/g, '$1' ), @@ -13461,23 +19054,71 @@ export namespace displayvideo_v1 { options ), params, - requiredParams: ['googleAudienceId'], - pathParams: ['googleAudienceId'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Inventorysources$Get + extends StandardParameters { + /** + * Required. The ID of the inventory source to fetch. + */ + inventorySourceId?: string; + /** + * Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysources$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the inventory source. + */ + advertiserId?: string; + /** + * Allows filtering by inventory source properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `status.entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the inventory source. + */ + partnerId?: string; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * displayvideo.googleAudiences.list - * @desc Lists Google audiences. The order is defined by the order_by parameter. + * displayvideo.media.download + * @desc Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string. * @example * // Before running the sample: * // - Enable the API at: @@ -13493,7 +19134,10 @@ export namespace displayvideo_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], + * scopes: [ + * 'https://www.googleapis.com/auth/display-video', + * 'https://www.googleapis.com/auth/doubleclickbidmanager', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -13501,56 +19145,16 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.googleAudiences.list({ - * // The ID of the advertiser that has access to the fetched Google audiences. - * advertiserId: 'placeholder-value', - * // Allows filtering by Google audience fields. - * // - * // Supported syntax: - * // - * // * Filter expressions for Google audiences currently can only contain at - * // most one restriction. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `CONTAINS (:)`. - * // * Supported fields: - * // - `displayName` - * // - * // Examples: - * // - * // * All Google audiences for which the display name contains "Google": - * // `displayName : "Google"`. - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Field by which to sort the list. - * // Acceptable values are: - * // - * // * `googleAudienceId` (default) - * // * `displayName` - * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. Example: - * // `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - * // is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListGoogleAudiences` method. - * // If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // The ID of the partner that has access to the fetched Google audiences. - * partnerId: 'placeholder-value', + * const res = await displayvideo.media.download({ + * // Name of the media that is being downloaded. See + * // ReadRequest.resource_name. + * resourceName: '.*', * }); * console.log(res.data); * * // Example response * // { - * // "googleAudiences": [], - * // "nextPageToken": "my_nextPageToken" + * // "resourceName": "my_resourceName" * // } * } * @@ -13559,71 +19163,65 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.googleAudiences.list + * @alias displayvideo.media.download * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched Google audiences. - * @param {string=} params.filter Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned. - * @param {string=} params.partnerId The ID of the partner that has access to the fetched Google audiences. + * @param {string} params.resourceName Name of the media that is being downloaded. See ReadRequest.resource_name. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params: Params$Resource$Googleaudiences$List, + download( + params: Params$Resource$Media$Download, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Googleaudiences$List, + download( + params?: Params$Resource$Media$Download, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Googleaudiences$List, + ): GaxiosPromise; + download( + params: Params$Resource$Media$Download, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Googleaudiences$List, + download( + params: Params$Resource$Media$Download, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Googleaudiences$List, - callback: BodyResponseCallback + download( + params: Params$Resource$Media$Download, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + download( + callback: BodyResponseCallback ): void; - list( + download( paramsOrCallback?: - | Params$Resource$Googleaudiences$List - | BodyResponseCallback + | Params$Resource$Media$Download + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Googleaudiences$List; + let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Googleaudiences$List; + params = {} as Params$Resource$Media$Download; options = {}; } @@ -13636,7 +19234,7 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/googleAudiences').replace( + url: (rootUrl + '/download/{+resourceName}').replace( /([^:]\/)\/+/g, '$1' ), @@ -13645,73 +19243,48 @@ export namespace displayvideo_v1 { options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['resourceName'], + pathParams: ['resourceName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Googleaudiences$Get - extends StandardParameters { - /** - * The ID of the advertiser that has access to the fetched Google audience. - */ - advertiserId?: string; - /** - * Required. The ID of the Google audience to fetch. - */ - googleAudienceId?: string; + export interface Params$Resource$Media$Download extends StandardParameters { /** - * The ID of the partner that has access to the fetched Google audience. + * Name of the media that is being downloaded. See ReadRequest.resource_name. */ - partnerId?: string; + resourceName?: string; } - export interface Params$Resource$Googleaudiences$List - extends StandardParameters { - /** - * The ID of the advertiser that has access to the fetched Google audiences. - */ - advertiserId?: string; - /** - * Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * The ID of the partner that has access to the fetched Google audiences. - */ - partnerId?: string; + + export class Resource$Partners { + context: APIRequestContext; + channels: Resource$Partners$Channels; + constructor(context: APIRequestContext) { + this.context = context; + this.channels = new Resource$Partners$Channels(this.context); + } } - export class Resource$Inventorysourcegroups { + export class Resource$Partners$Channels { context: APIRequestContext; + sites: Resource$Partners$Channels$Sites; constructor(context: APIRequestContext) { this.context = context; + this.sites = new Resource$Partners$Channels$Sites(this.context); } /** - * displayvideo.inventorySourceGroups.get - * @desc Gets an inventory source group. + * displayvideo.partners.channels.get + * @desc Gets a channel for a partner or advertiser. * @example * // Before running the sample: * // - Enable the API at: @@ -13735,26 +19308,23 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.inventorySourceGroups.get({ - * // The ID of the advertiser that has access to the inventory source group. - * // - * // If an inventory source group is partner-owned, only advertisers to which - * // the group is explicitly shared can access the group. + * const res = await displayvideo.partners.channels.get({ + * // The ID of the advertiser that owns the fetched channel. * advertiserId: 'placeholder-value', - * // Required. The ID of the inventory source group to fetch. - * inventorySourceGroupId: '[^/]+', - * // The ID of the partner that has access to the inventory source group. - * // - * // A partner cannot access an advertiser-owned inventory source group. - * partnerId: 'placeholder-value', + * // Required. The ID of the channel to fetch. + * channelId: '[^/]+', + * // The ID of the partner that owns the fetched channel. + * partnerId: '[^/]+', * }); * console.log(res.data); * * // Example response * // { + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", * // "displayName": "my_displayName", - * // "inventorySourceGroupId": "my_inventorySourceGroupId", - * // "name": "my_name" + * // "name": "my_name", + * // "partnerId": "my_partnerId" * // } * } * @@ -13763,66 +19333,61 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.inventorySourceGroups.get + * @alias displayvideo.partners.channels.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. - * @param {string} params.inventorySourceGroupId Required. The ID of the inventory source group to fetch. - * @param {string=} params.partnerId The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. + * @param {string=} params.advertiserId The ID of the advertiser that owns the fetched channel. + * @param {string} params.channelId Required. The ID of the channel to fetch. + * @param {string} params.partnerId The ID of the partner that owns the fetched channel. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params: Params$Resource$Inventorysourcegroups$Get, + params: Params$Resource$Partners$Channels$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Inventorysourcegroups$Get, + params?: Params$Resource$Partners$Channels$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Inventorysourcegroups$Get, + params: Params$Resource$Partners$Channels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Inventorysourcegroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Partners$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Inventorysourcegroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Partners$Channels$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Inventorysourcegroups$Get - | BodyResponseCallback + | Params$Resource$Partners$Channels$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Inventorysourcegroups$Get; + {}) as Params$Resource$Partners$Channels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Inventorysourcegroups$Get; + params = {} as Params$Resource$Partners$Channels$Get; options = {}; } @@ -13836,30 +19401,30 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/inventorySourceGroups/{+inventorySourceGroupId}' + rootUrl + '/v1/partners/{+partnerId}/channels/{+channelId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['inventorySourceGroupId'], - pathParams: ['inventorySourceGroupId'], + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.inventorySourceGroups.list - * @desc Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter. + * displayvideo.partners.channels.list + * @desc Lists channels for a partner or advertiser. * @example * // Before running the sample: * // - Enable the API at: @@ -13883,22 +19448,24 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.inventorySourceGroups.list({ - * // The ID of the advertiser that has access to the inventory source group. - * // - * // If an inventory source group is partner-owned, only advertisers to which - * // the group is explicitly shared can access the group. + * const res = await displayvideo.partners.channels.list({ + * // The ID of the advertiser that owns the channels. * advertiserId: 'placeholder-value', - * // Allows filtering by inventory source group properties. + * // Allows filtering by channel fields. * // * // Supported syntax: * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by the logical operator `OR`. + * // * Filter expressions for channel currently can only contain at most one + * // * restriction. * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)`. + * // * The operator must be `CONTAINS (:)`. * // * Supported fields: - * // - `inventorySourceGroupId` + * // - `displayName` + * // + * // Examples: + * // + * // * All channels for which the display name contains "google": + * // `displayName : "google"`. * // * // The length of this field should be no more than 500 characters. * filter: 'placeholder-value', @@ -13906,31 +19473,30 @@ export namespace displayvideo_v1 { * // Acceptable values are: * // * // * `displayName` (default) - * // * `inventorySourceGroupId` + * // * `channelId` * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. For example, + * // The default sorting order is ascending. To specify descending order for a + * // field, a suffix " desc" should be added to the field name. Example: * // `displayName desc`. * orderBy: 'placeholder-value', * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. + * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + * // is specified. * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListInventorySources` method. - * // If not specified, the first page of results will be returned. + * // next_page_token returned from the + * // previous call to `ListChannels` method. If not specified, the first page + * // of results will be returned. * pageToken: 'placeholder-value', - * // The ID of the partner that has access to the inventory source group. - * // - * // A partner cannot access advertiser-owned inventory source groups. - * partnerId: 'placeholder-value', + * // The ID of the partner that owns the channels. + * partnerId: '[^/]+', * }); * console.log(res.data); * * // Example response * // { - * // "inventorySourceGroups": [], + * // "channels": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -13940,71 +19506,69 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.inventorySourceGroups.list + * @alias displayvideo.partners.channels.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. - * @param {string=} params.filter Allows filtering by inventory source group properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. - * @param {string=} params.partnerId The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. + * @param {string=} params.advertiserId The ID of the advertiser that owns the channels. + * @param {string=} params.filter Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + * @param {string} params.partnerId The ID of the partner that owns the channels. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params: Params$Resource$Inventorysourcegroups$List, + params: Params$Resource$Partners$Channels$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Inventorysourcegroups$List, + params?: Params$Resource$Partners$Channels$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Inventorysourcegroups$List, + params: Params$Resource$Partners$Channels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Inventorysourcegroups$List, + params: Params$Resource$Partners$Channels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Inventorysourcegroups$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Partners$Channels$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Inventorysourcegroups$List - | BodyResponseCallback + | Params$Resource$Partners$Channels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Inventorysourcegroups$List; + {}) as Params$Resource$Partners$Channels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Inventorysourcegroups$List; + params = {} as Params$Resource$Partners$Channels$List; options = {}; } @@ -14017,7 +19581,7 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/inventorySourceGroups').replace( + url: (rootUrl + '/v1/partners/{+partnerId}/channels').replace( /([^:]\/)\/+/g, '$1' ), @@ -14026,75 +19590,23 @@ export namespace displayvideo_v1 { options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['partnerId'], + pathParams: ['partnerId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Inventorysourcegroups$Get - extends StandardParameters { - /** - * The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. - */ - advertiserId?: string; - /** - * Required. The ID of the inventory source group to fetch. - */ - inventorySourceGroupId?: string; - /** - * The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. - */ - partnerId?: string; - } - export interface Params$Resource$Inventorysourcegroups$List - extends StandardParameters { - /** - * The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. - */ - advertiserId?: string; - /** - * Allows filtering by inventory source group properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. - */ - partnerId?: string; - } - - export class Resource$Inventorysources { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * displayvideo.inventorySources.get - * @desc Gets an inventory source. + * displayvideo.partners.channels.patch + * @desc Updates a channel. Returns the updated channel if successful. * @example * // Before running the sample: * // - Enable the API at: @@ -14118,31 +19630,37 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.inventorySources.get({ - * // Required. The ID of the inventory source to fetch. - * inventorySourceId: '[^/]+', - * // Required. The ID of the DV360 partner to which the fetched inventory source - * // is permissioned. - * partnerId: 'placeholder-value', + * const res = await displayvideo.partners.channels.patch({ + * // The ID of the advertiser that owns the created channel. + * advertiserId: 'placeholder-value', + * // Output only. The unique ID of the channel. Assigned by the system. + * channelId: 'placeholder-value', + * // The ID of the partner that owns the created channel. + * partnerId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "partnerId": "my_partnerId" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "commitment": "my_commitment", - * // "creativeConfigs": [], - * // "dealId": "my_dealId", - * // "deliveryMethod": "my_deliveryMethod", + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", * // "displayName": "my_displayName", - * // "exchange": "my_exchange", - * // "inventorySourceId": "my_inventorySourceId", - * // "inventorySourceType": "my_inventorySourceType", * // "name": "my_name", - * // "publisherName": "my_publisherName", - * // "rateDetails": {}, - * // "status": {}, - * // "timeRange": {}, - * // "updateTime": "my_updateTime" + * // "partnerId": "my_partnerId" * // } * } * @@ -14151,60 +19669,63 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.inventorySources.get + * @alias displayvideo.partners.channels.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.inventorySourceId Required. The ID of the inventory source to fetch. - * @param {string=} params.partnerId Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. + * @param {string=} params.advertiserId The ID of the advertiser that owns the created channel. + * @param {string} params.channelId Output only. The unique ID of the channel. Assigned by the system. + * @param {string} params.partnerId The ID of the partner that owns the created channel. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().Channel} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Inventorysources$Get, + patch( + params: Params$Resource$Partners$Channels$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Inventorysources$Get, + patch( + params?: Params$Resource$Partners$Channels$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Inventorysources$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Partners$Channels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Inventorysources$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Partners$Channels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Inventorysources$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Partners$Channels$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Inventorysources$Get - | BodyResponseCallback + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Inventorysources$Get; + {}) as Params$Resource$Partners$Channels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Inventorysources$Get; + params = {} as Params$Resource$Partners$Channels$Patch; options = {}; } @@ -14218,30 +19739,104 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/inventorySources/{+inventorySourceId}' + rootUrl + '/v1/partners/{+partnerId}/channels/{channelId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', }, options ), params, - requiredParams: ['inventorySourceId'], - pathParams: ['inventorySourceId'], + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Partners$Channels$Get + extends StandardParameters { /** - * displayvideo.inventorySources.list - * @desc Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * The ID of the advertiser that owns the fetched channel. + */ + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + + export class Resource$Partners$Channels$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.partners.channels.sites.bulkEdit + * @desc Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. * @example * // Before running the sample: * // - Enable the API at: @@ -14265,61 +19860,28 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.inventorySources.list({ - * // The ID of the advertiser that has access to the inventory source. - * advertiserId: 'placeholder-value', - * // Allows filtering by inventory source properties. - * // - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by `AND` or `OR` logical operators. A - * // sequence of restrictions implicitly uses `AND`. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * The operator must be `EQUALS (=)`. - * // * Supported fields: - * // - `status.entityStatus` - * // - `commitment` - * // - `deliveryMethod` - * // - `rateDetails.rateType` - * // - `exchange` - * // - * // Examples: - * // - * // * All active inventory sources: - * // `status.entityStatus="ENTITY_STATUS_ACTIVE"` - * // * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: - * // `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` - * // - * // The length of this field should be no more than 500 characters. - * filter: 'placeholder-value', - * // Field by which to sort the list. - * // Acceptable values are: - * // - * // * `displayName` (default) - * // - * // The default sorting order is ascending. To specify descending order for - * // a field, a suffix "desc" should be added to the field name. For example, - * // `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will - * // default to `100`. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // next_page_token - * // returned from the previous call to `ListInventorySources` method. - * // If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // The ID of the partner that has access to the inventory source. + * const res = await displayvideo.partners.channels.sites.bulkEdit({ + * // Required. The ID of the parent channel to which the sites belong. + * channelId: '[^/]+', + * // The ID of the partner that owns the parent channel. * partnerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "createdSites": [], + * // "deletedSites": [], + * // "partnerId": "my_partnerId" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "inventorySources": [], - * // "nextPageToken": "my_nextPageToken" + * // "sites": [] * // } * } * @@ -14328,71 +19890,68 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.inventorySources.list + * @alias displayvideo.partners.channels.sites.bulkEdit * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source. - * @param {string=} params.filter Allows filtering by inventory source properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `status.entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. - * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. - * @param {string=} params.partnerId The ID of the partner that has access to the inventory source. + * @param {string} params.channelId Required. The ID of the parent channel to which the sites belong. + * @param {string} params.partnerId The ID of the partner that owns the parent channel. + * @param {().BulkEditSitesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params: Params$Resource$Inventorysources$List, + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Inventorysources$List, + bulkEdit( + params?: Params$Resource$Partners$Channels$Sites$Bulkedit, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Inventorysources$List, + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Inventorysources$List, + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Inventorysources$List, - callback: BodyResponseCallback + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + bulkEdit( + callback: BodyResponseCallback ): void; - list( + bulkEdit( paramsOrCallback?: - | Params$Resource$Inventorysources$List - | BodyResponseCallback + | Params$Resource$Partners$Channels$Sites$Bulkedit + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Inventorysources$List; + {}) as Params$Resource$Partners$Channels$Sites$Bulkedit; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Inventorysources$List; + params = {} as Params$Resource$Partners$Channels$Sites$Bulkedit; options = {}; } @@ -14405,80 +19964,32 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/inventorySources').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + + '/v1/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Inventorysources$Get - extends StandardParameters { - /** - * Required. The ID of the inventory source to fetch. - */ - inventorySourceId?: string; - /** - * Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. - */ - partnerId?: string; - } - export interface Params$Resource$Inventorysources$List - extends StandardParameters { - /** - * The ID of the advertiser that has access to the inventory source. - */ - advertiserId?: string; - /** - * Allows filtering by inventory source properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `status.entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * The ID of the partner that has access to the inventory source. - */ - partnerId?: string; - } - - export class Resource$Media { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * displayvideo.media.download - * @desc Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string. + * displayvideo.partners.channels.sites.create + * @desc Creates a site in a channel. * @example * // Before running the sample: * // - Enable the API at: @@ -14494,10 +20005,7 @@ export namespace displayvideo_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/display-video', - * 'https://www.googleapis.com/auth/doubleclickbidmanager', - * ], + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -14505,16 +20013,29 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.media.download({ - * // Name of the media that is being downloaded. See - * // ReadRequest.resource_name. - * resourceName: '.*', + * const res = await displayvideo.partners.channels.sites.create({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel in which the site will be created. + * channelId: '[^/]+', + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "name": "my_name", + * // "urlOrAppId": "my_urlOrAppId" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "resourceName": "my_resourceName" + * // "name": "my_name", + * // "urlOrAppId": "my_urlOrAppId" * // } * } * @@ -14523,65 +20044,62 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.media.download + * @alias displayvideo.partners.channels.sites.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resourceName Name of the media that is being downloaded. See ReadRequest.resource_name. + * @param {string=} params.advertiserId The ID of the advertiser that owns the parent channel. + * @param {string} params.channelId Required. The ID of the parent channel in which the site will be created. + * @param {string} params.partnerId The ID of the partner that owns the parent channel. + * @param {().Site} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - download( - params: Params$Resource$Media$Download, + create( + params: Params$Resource$Partners$Channels$Sites$Create, options: StreamMethodOptions ): GaxiosPromise; - download( - params?: Params$Resource$Media$Download, + create( + params?: Params$Resource$Partners$Channels$Sites$Create, options?: MethodOptions - ): GaxiosPromise; - download( - params: Params$Resource$Media$Download, + ): GaxiosPromise; + create( + params: Params$Resource$Partners$Channels$Sites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - download( - params: Params$Resource$Media$Download, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - download( - params: Params$Resource$Media$Download, - callback: BodyResponseCallback + create( + params: Params$Resource$Partners$Channels$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - download( - callback: BodyResponseCallback + create( + params: Params$Resource$Partners$Channels$Sites$Create, + callback: BodyResponseCallback ): void; - download( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Media$Download - | BodyResponseCallback + | Params$Resource$Partners$Channels$Sites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Media$Download; + params = {} as Params$Resource$Partners$Channels$Sites$Create; options = {}; } @@ -14594,55 +20112,31 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/download/{+resourceName}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1/partners/{partnerId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['resourceName'], - pathParams: ['resourceName'], + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Media$Download extends StandardParameters { - /** - * Name of the media that is being downloaded. See ReadRequest.resource_name. - */ - resourceName?: string; - } - - export class Resource$Partners { - context: APIRequestContext; - channels: Resource$Partners$Channels; - constructor(context: APIRequestContext) { - this.context = context; - this.channels = new Resource$Partners$Channels(this.context); - } - } - - export class Resource$Partners$Channels { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * displayvideo.partners.channels.get - * @desc Gets a channel for a partner or advertiser. + * displayvideo.partners.channels.sites.delete + * @desc Deletes a site from a channel. * @example * // Before running the sample: * // - Enable the API at: @@ -14666,24 +20160,20 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.partners.channels.get({ - * // The ID of the advertiser that owns the fetched channel. + * const res = await displayvideo.partners.channels.sites.delete({ + * // The ID of the advertiser that owns the parent channel. * advertiserId: 'placeholder-value', - * // Required. The ID of the channel to fetch. + * // Required. The ID of the parent channel to which the site belongs. * channelId: '[^/]+', - * // The ID of the partner that owns the fetched channel. - * partnerId: '[^/]+', + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', + * // Required. The URL or app ID of the site to delete. + * urlOrAppId: '[^/]+', * }); * console.log(res.data); * * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "partnerId": "my_partnerId" - * // } + * // {} * } * * main().catch(e => { @@ -14691,61 +20181,62 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.partners.channels.get + * @alias displayvideo.partners.channels.sites.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that owns the fetched channel. - * @param {string} params.channelId Required. The ID of the channel to fetch. - * @param {string} params.partnerId The ID of the partner that owns the fetched channel. + * @param {string=} params.advertiserId The ID of the advertiser that owns the parent channel. + * @param {string} params.channelId Required. The ID of the parent channel to which the site belongs. + * @param {string} params.partnerId The ID of the partner that owns the parent channel. + * @param {string} params.urlOrAppId Required. The URL or app ID of the site to delete. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params: Params$Resource$Partners$Channels$Get, + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Partners$Channels$Get, + delete( + params?: Params$Resource$Partners$Channels$Sites$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Partners$Channels$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Partners$Channels$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Partners$Channels$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Partners$Channels$Get - | BodyResponseCallback + | Params$Resource$Partners$Channels$Sites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Partners$Channels$Get; + {}) as Params$Resource$Partners$Channels$Sites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Partners$Channels$Get; + params = {} as Params$Resource$Partners$Channels$Sites$Delete; options = {}; } @@ -14759,30 +20250,31 @@ export namespace displayvideo_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/partners/{+partnerId}/channels/{+channelId}' + rootUrl + + '/v1/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), params, - requiredParams: ['partnerId', 'channelId'], - pathParams: ['channelId', 'partnerId'], + requiredParams: ['partnerId', 'channelId', 'urlOrAppId'], + pathParams: ['channelId', 'partnerId', 'urlOrAppId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * displayvideo.partners.channels.list - * @desc Lists channels for a partner or advertiser. + * displayvideo.partners.channels.sites.list + * @desc Lists sites in a channel. * @example * // Before running the sample: * // - Enable the API at: @@ -14806,56 +20298,56 @@ export namespace displayvideo_v1 { * google.options('auth', authClient); * * // Do the magic - * const res = await displayvideo.partners.channels.list({ - * // The ID of the advertiser that owns the channels. + * const res = await displayvideo.partners.channels.sites.list({ + * // The ID of the advertiser that owns the parent channel. * advertiserId: 'placeholder-value', - * // Allows filtering by channel fields. + * // Required. The ID of the parent channel to which the requested sites belong. + * channelId: '[^/]+', + * // Allows filtering by site fields. * // * // Supported syntax: * // - * // * Filter expressions for channel currently can only contain at most one + * // * Filter expressions for site currently can only contain at most one * // * restriction. * // * A restriction has the form of `{field} {operator} {value}`. * // * The operator must be `CONTAINS (:)`. * // * Supported fields: - * // - `displayName` + * // - `urlOrAppId` * // * // Examples: * // - * // * All channels for which the display name contains "google": - * // `displayName : "google"`. - * // - * // The length of this field should be no more than 500 characters. + * // * All sites for which the URL or app ID contains "google": + * // `urlOrAppId : "google"` * filter: 'placeholder-value', * // Field by which to sort the list. * // Acceptable values are: * // - * // * `displayName` (default) - * // * `channelId` + * // * `urlOrAppId` (default) * // * // The default sorting order is ascending. To specify descending order for a * // field, a suffix " desc" should be added to the field name. Example: - * // `displayName desc`. + * // `urlOrAppId desc`. * orderBy: 'placeholder-value', * // Requested page size. Must be between `1` and `100`. If unspecified will * // default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value * // is specified. * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. + * // * // Typically, this is the value of * // next_page_token returned from the - * // previous call to `ListChannels` method. If not specified, the first page + * // previous call to `ListSites` method. If not specified, the first page * // of results will be returned. * pageToken: 'placeholder-value', - * // The ID of the partner that owns the channels. + * // The ID of the partner that owns the parent channel. * partnerId: '[^/]+', * }); * console.log(res.data); * * // Example response * // { - * // "channels": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "sites": [] * // } * } * @@ -14864,69 +20356,68 @@ export namespace displayvideo_v1 { * throw e; * }); * - * @alias displayvideo.partners.channels.list + * @alias displayvideo.partners.channels.sites.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the advertiser that owns the channels. - * @param {string=} params.filter Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. - * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + * @param {string=} params.advertiserId The ID of the advertiser that owns the parent channel. + * @param {string} params.channelId Required. The ID of the parent channel to which the requested sites belong. + * @param {string=} params.filter Allows filtering by site fields. Supported syntax: * Filter expressions for site currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. - * @param {string} params.partnerId The ID of the partner that owns the channels. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. + * @param {string} params.partnerId The ID of the partner that owns the parent channel. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params: Params$Resource$Partners$Channels$List, + params: Params$Resource$Partners$Channels$Sites$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Partners$Channels$List, + params?: Params$Resource$Partners$Channels$Sites$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Partners$Channels$List, + params: Params$Resource$Partners$Channels$Sites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Partners$Channels$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Partners$Channels$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Partners$Channels$List, - callback: BodyResponseCallback + params: Params$Resource$Partners$Channels$Sites$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Partners$Channels$List - | BodyResponseCallback + | Params$Resource$Partners$Channels$Sites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Partners$Channels$List; + {}) as Params$Resource$Partners$Channels$Sites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Partners$Channels$List; + params = {} as Params$Resource$Partners$Channels$Sites$List; options = {}; } @@ -14939,57 +20430,100 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/partners/{+partnerId}/channels').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/partners/{+partnerId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['partnerId'], - pathParams: ['partnerId'], + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Partners$Channels$Get + export interface Params$Resource$Partners$Channels$Sites$Bulkedit extends StandardParameters { /** - * The ID of the advertiser that owns the fetched channel. + * Required. The ID of the parent channel to which the sites belong. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditSitesRequest; + } + export interface Params$Resource$Partners$Channels$Sites$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. */ advertiserId?: string; /** - * Required. The ID of the channel to fetch. + * Required. The ID of the parent channel in which the site will be created. */ channelId?: string; /** - * The ID of the partner that owns the fetched channel. + * The ID of the partner that owns the parent channel. */ partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; } - export interface Params$Resource$Partners$Channels$List + export interface Params$Resource$Partners$Channels$Sites$Delete extends StandardParameters { /** - * The ID of the advertiser that owns the channels. + * The ID of the advertiser that owns the parent channel. */ advertiserId?: string; /** - * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. + * Required. The ID of the parent channel to which the site belongs. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + /** + * Required. The URL or app ID of the site to delete. + */ + urlOrAppId?: string; + } + export interface Params$Resource$Partners$Channels$Sites$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the requested sites belong. + */ + channelId?: string; + /** + * Allows filtering by site fields. Supported syntax: * Filter expressions for site currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` */ filter?: string; /** - * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + * Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. */ orderBy?: string; /** @@ -14997,11 +20531,11 @@ export namespace displayvideo_v1 { */ pageSize?: number; /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. */ pageToken?: string; /** - * The ID of the partner that owns the channels. + * The ID of the partner that owns the parent channel. */ partnerId?: string; }