googleapis
Version:
Google APIs Client Library for Node.js
1,162 lines • 1.14 MB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace displayvideo_v3 {
export interface Options extends GlobalOptions {
version: 'v3';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Display & Video 360 API
*
* Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.
*
* @example
* ```js
* const {google} = require('googleapis');
* const displayvideo = google.displayvideo('v3');
* ```
*/
export class Displayvideo {
context: APIRequestContext;
advertisers: Resource$Advertisers;
combinedAudiences: Resource$Combinedaudiences;
customBiddingAlgorithms: Resource$Custombiddingalgorithms;
customLists: Resource$Customlists;
firstAndThirdPartyAudiences: Resource$Firstandthirdpartyaudiences;
floodlightGroups: Resource$Floodlightgroups;
googleAudiences: Resource$Googleaudiences;
guaranteedOrders: Resource$Guaranteedorders;
inventorySourceGroups: Resource$Inventorysourcegroups;
inventorySources: Resource$Inventorysources;
media: Resource$Media;
partners: Resource$Partners;
sdfdownloadtasks: Resource$Sdfdownloadtasks;
targetingTypes: Resource$Targetingtypes;
users: Resource$Users;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Configuration for custom Active View video viewability metrics.
*/
export interface Schema$ActiveViewVideoViewabilityMetricConfig {
/**
* Required. The display name of the custom metric.
*/
displayName?: string | null;
/**
* The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
*/
minimumDuration?: string | null;
/**
* The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
*/
minimumQuartile?: string | null;
/**
* Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.
*/
minimumViewability?: string | null;
/**
* Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.
*/
minimumVolume?: string | null;
}
/**
* A single ad group associated with a line item.
*/
export interface Schema$AdGroup {
/**
* The format of the ads in the ad group.
*/
adGroupFormat?: string | null;
/**
* The unique ID of the ad group. Assigned by the system.
*/
adGroupId?: string | null;
/**
* The unique ID of the advertiser the ad group belongs to.
*/
advertiserId?: string | null;
/**
* The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
*/
bidStrategy?: Schema$BiddingStrategy;
/**
* The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
*/
displayName?: string | null;
/**
* Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
*/
entityStatus?: string | null;
/**
* The unique ID of the line item that the ad group belongs to.
*/
lineItemId?: string | null;
/**
* The resource name of the ad group.
*/
name?: string | null;
/**
* The settings of the product feed in this ad group.
*/
productFeedData?: Schema$ProductFeedData;
/**
* The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
*/
targetingExpansion?: Schema$TargetingExpansionConfig;
}
/**
* A single ad associated with an ad group.
*/
export interface Schema$AdGroupAd {
/**
* Output only. The unique ID of the ad. Assigned by the system.
*/
adGroupAdId?: string | null;
/**
* The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.
*/
adGroupId?: string | null;
/**
* Output only. The policy approval status of the ad.
*/
adPolicy?: Schema$AdPolicy;
/**
* List of URLs used by the ad.
*/
adUrls?: Schema$AdUrl[];
/**
* Output only. The unique ID of the advertiser the ad belongs to.
*/
advertiserId?: string | null;
/**
* Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
*/
audioAd?: Schema$AudioAd;
/**
* Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
*/
bumperAd?: Schema$BumperAd;
/**
* The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
*/
displayName?: string | null;
/**
* Details of an ad sourced from a Display & Video 360 creative.
*/
displayVideoSourceAd?: Schema$DisplayVideoSourceAd;
/**
* The entity status of the ad.
*/
entityStatus?: string | null;
/**
* Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
*/
inStreamAd?: Schema$InStreamAd;
/**
* Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
*/
mastheadAd?: Schema$MastheadAd;
/**
* Output only. The resource name of the ad.
*/
name?: string | null;
/**
* Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
*/
nonSkippableAd?: Schema$NonSkippableAd;
/**
* Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
*/
videoDiscoverAd?: Schema$VideoDiscoveryAd;
/**
* Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
*/
videoPerformanceAd?: Schema$VideoPerformanceAd;
}
/**
* Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.
*/
export interface Schema$AdGroupAssignedTargetingOption {
/**
* The ID of the ad group the assigned targeting option is assigned to.
*/
adGroupId?: string | null;
/**
* The assigned targeting option resource.
*/
assignedTargetingOption?: Schema$AssignedTargetingOption;
}
/**
* Details of Scope3 (previously known as Adloox) brand safety settings.
*/
export interface Schema$Adloox {
/**
* Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
adultExplicitSexualContent?: string | null;
/**
* Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
armsAmmunitionContent?: string | null;
/**
* Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent?: string | null;
/**
* Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
deathInjuryMilitaryConflictContent?: string | null;
/**
* Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
debatedSensitiveSocialIssueContent?: string | null;
/**
* Optional. IAB viewability threshold for display ads.
*/
displayIabViewability?: string | null;
/**
* Scope3 categories to exclude.
*/
excludedAdlooxCategories?: string[] | null;
/**
* Optional. Scope3's fraud IVT MFA categories to exclude.
*/
excludedFraudIvtMfaCategories?: string[] | null;
/**
* Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
hateSpeechActsAggressionContent?: string | null;
/**
* Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
illegalDrugsTobaccoEcigarettesVapingAlcoholContent?: string | null;
/**
* Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
misinformationContent?: string | null;
/**
* Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
obscenityProfanityContent?: string | null;
/**
* Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
onlinePiracyContent?: string | null;
/**
* Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
spamHarmfulContent?: string | null;
/**
* Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
*/
terrorismContent?: string | null;
/**
* Optional. IAB viewability threshold for video ads.
*/
videoIabViewability?: string | null;
}
/**
* A single ad policy associated with an ad group ad.
*/
export interface Schema$AdPolicy {
/**
* The policy approval status of an ad, indicating the approval decision.
*/
adPolicyApprovalStatus?: string | null;
/**
* The policy review status of an ad, indicating where in the review process the ad is currently.
*/
adPolicyReviewStatus?: string | null;
/**
* The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
*/
adPolicyTopicEntry?: Schema$AdPolicyTopicEntry[];
}
/**
* Represents a country restriction.
*/
export interface Schema$AdPolicyCriterionRestriction {
/**
* The country criterion id.
*/
countryCriterionId?: string | null;
/**
* Localized name for the country. May be empty.
*/
countryLabel?: string | null;
}
/**
* Information on how to appeal a policy decision.
*/
export interface Schema$AdPolicyTopicAppealInfo {
/**
* Only available when appeal_type is `APPEAL_FORM`.
*/
appealFormLink?: string | null;
/**
* Whether the decision can be appealed through a self-service appeal or an appeal form.
*/
appealType?: string | null;
}
/**
* Details on ad serving constraints.
*/
export interface Schema$AdPolicyTopicConstraint {
/**
* Countries where the resource's domain is not covered by the certificates associated with it.
*/
certificateDomainMismatchCountryList?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList;
/**
* Countries where a certificate is required for serving.
*/
certificateMissingCountryList?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList;
/**
* Countries where the ad cannot serve.
*/
countryConstraint?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList;
/**
* Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
*/
globalCertificateDomainMismatch?: Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint;
/**
* Certificate is required to serve in any country.
*/
globalCertificateMissing?: Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint;
/**
* Link to the form to request a certificate for the constraint.
*/
requestCertificateFormLink?: string | null;
/**
* Reseller constraint.
*/
resellerConstraint?: Schema$AdPolicyTopicConstraintAdPolicyResellerConstraint;
}
/**
* A list of countries where the ad cannot serve due to policy constraints.
*/
export interface Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList {
/**
* Countries where the ad cannot serve.
*/
countries?: Schema$AdPolicyCriterionRestriction[];
}
/**
* Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
*/
export interface Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint {
}
/**
* Certificate is required to serve in any country.
*/
export interface Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint {
}
/**
* Policy topic was constrained due to disapproval of the website for reseller purposes.
*/
export interface Schema$AdPolicyTopicConstraintAdPolicyResellerConstraint {
}
/**
* An entry describing how an ad has been identified as relating to an ad policy.
*/
export interface Schema$AdPolicyTopicEntry {
/**
* Information on how to appeal the policy decision.
*/
appealInfo?: Schema$AdPolicyTopicAppealInfo;
/**
* Ad policy help center link for the policy topic.
*/
helpCenterLink?: string | null;
/**
* The source of the policy decision.
*/
policyDecisionType?: string | null;
/**
* The policy enforcement means used in the policy review.
*/
policyEnforcementMeans?: string | null;
/**
* Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
*/
policyLabel?: string | null;
/**
* The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
*/
policyTopic?: string | null;
/**
* The serving constraints relevant to the policy decision.
*/
policyTopicConstraints?: Schema$AdPolicyTopicConstraint[];
/**
* A short summary description of the policy topic.
*/
policyTopicDescription?: string | null;
/**
* The evidence used in the policy decision.
*/
policyTopicEvidences?: Schema$AdPolicyTopicEvidence[];
/**
* How ad serving will be affected due to the relation to the ad policy topic.
*/
policyTopicType?: string | null;
}
/**
* Evidence information used in the policy decision.
*/
export interface Schema$AdPolicyTopicEvidence {
/**
* Counterfeit enforcement that caused a policy violation.
*/
counterfeit?: Schema$AdPolicyTopicEvidenceCounterfeit;
/**
* A mismatch between the ad destination URLs.
*/
destinationMismatch?: Schema$AdPolicyTopicEvidenceDestinationMismatch;
/**
* Information on HTTP or DNS errors related to the ad destination.
*/
destinationNotWorking?: Schema$AdPolicyTopicEvidenceDestinationNotWorking;
/**
* The text in the destination of the ad that is causing a policy violation.
*/
destinationTextList?: Schema$AdPolicyTopicEvidenceDestinationTextList;
/**
* HTTP code returned when the final URL was crawled.
*/
httpCode?: number | null;
/**
* The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
*/
languageCode?: string | null;
/**
* Legal related regulation enforcement that caused a policy violation.
*/
legalRemoval?: Schema$AdPolicyTopicEvidenceLegalRemoval;
/**
* T&S proactive enforcement that caused a policy violation.
*/
regionalRequirements?: Schema$AdPolicyTopicEvidenceRegionalRequirements;
/**
* List of evidence found in the text of the ad.
*/
textList?: Schema$AdPolicyTopicEvidenceTextList;
/**
* Trademark terms that caused a policy violation.
*/
trademark?: Schema$AdPolicyTopicEvidenceTrademark;
/**
* List of websites linked with the ad.
*/
websiteList?: Schema$AdPolicyTopicEvidenceWebsiteList;
}
/**
* Details on the counterfeit enforcement that caused a policy violation.
*/
export interface Schema$AdPolicyTopicEvidenceCounterfeit {
/**
* The content or product owners that made a complaint.
*/
owners?: string[] | null;
}
/**
* Details on a mismatch between destination URL types.
*/
export interface Schema$AdPolicyTopicEvidenceDestinationMismatch {
/**
* The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
*/
uriTypes?: string[] | null;
}
/**
* Details for on HTTP or DNS errors related to the ad destination.
*/
export interface Schema$AdPolicyTopicEvidenceDestinationNotWorking {
/**
* The device where visiting the URL resulted in the error.
*/
device?: string | null;
/**
* The type of DNS error.
*/
dnsErrorType?: string | null;
/**
* The full URL that didn't work.
*/
expandedUri?: string | null;
/**
* The HTTP error code.
*/
httpErrorCode?: string | null;
/**
* The last time the error was seen when navigating to URL.
*/
lastCheckedTime?: string | null;
}
/**
* A list of destination text that violated the policy.
*/
export interface Schema$AdPolicyTopicEvidenceDestinationTextList {
/**
* Destination text that caused the policy finding.
*/
destinationTexts?: string[] | null;
}
/**
* Legal related regulation enforcement, either from DMCA or local legal regulation.
*/
export interface Schema$AdPolicyTopicEvidenceLegalRemoval {
/**
* The type of complaint causing the legal removal.
*/
complaintType?: string | null;
/**
* The countries restricted due to the legal removal.
*/
countryRestrictions?: Schema$AdPolicyCriterionRestriction[];
/**
* Details on the DMCA regulation legal removal.
*/
dmca?: Schema$AdPolicyTopicEvidenceLegalRemovalDmca;
/**
* Details on the local legal regulation legal removal.
*/
localLegal?: Schema$AdPolicyTopicEvidenceLegalRemovalLocalLegal;
/**
* The urls restricted due to the legal removal.
*/
restrictedUris?: string[] | null;
}
/**
* DMCA complaint details.
*/
export interface Schema$AdPolicyTopicEvidenceLegalRemovalDmca {
/**
* The entity who made the legal complaint.
*/
complainant?: string | null;
}
/**
* Local legal regulation details.
*/
export interface Schema$AdPolicyTopicEvidenceLegalRemovalLocalLegal {
/**
* Type of law for the legal notice.
*/
lawType?: string | null;
}
/**
* Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement.
*/
export interface Schema$AdPolicyTopicEvidenceRegionalRequirements {
/**
* List of regional requirements.
*/
regionalRequirementsEntries?: Schema$AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry[];
}
/**
* Policy level regional legal violation details.
*/
export interface Schema$AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry {
/**
* The countries restricted due to the legal policy.
*/
countryRestrictions?: Schema$AdPolicyCriterionRestriction[];
/**
* The legal policy that is being violated.
*/
legalPolicy?: string | null;
}
/**
* A list of fragments of text that violated the policy.
*/
export interface Schema$AdPolicyTopicEvidenceTextList {
/**
* The fragments of text from the resource that caused the policy finding.
*/
texts?: string[] | null;
}
/**
* Trademark terms that caused a policy violation.
*/
export interface Schema$AdPolicyTopicEvidenceTrademark {
/**
* Countries where the policy violation is relevant.
*/
countryRestrictions?: Schema$AdPolicyCriterionRestriction[];
/**
* The trademark content owner.
*/
owner?: string | null;
/**
* The trademark term.
*/
term?: string | null;
}
/**
* A list of websites that violated the policy.
*/
export interface Schema$AdPolicyTopicEvidenceWebsiteList {
/**
* Websites that caused the policy finding.
*/
websites?: string[] | null;
}
/**
* Additional URLs related to the ad, including beacons.
*/
export interface Schema$AdUrl {
/**
* The type of the Ad URL.
*/
type?: string | null;
/**
* The URL string value.
*/
url?: string | null;
}
/**
* A single advertiser in Display & Video 360 (DV360).
*/
export interface Schema$Advertiser {
/**
* Required. Immutable. Ad server related settings of the advertiser.
*/
adServerConfig?: Schema$AdvertiserAdServerConfig;
/**
* Output only. The unique ID of the advertiser. Assigned by the system.
*/
advertiserId?: string | null;
/**
* Required. Billing related settings of the advertiser.
*/
billingConfig?: Schema$AdvertiserBillingConfig;
/**
* Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
*/
containsEuPoliticalAds?: string | null;
/**
* Required. Creative related settings of the advertiser.
*/
creativeConfig?: Schema$AdvertiserCreativeConfig;
/**
* Settings that control how advertiser data may be accessed.
*/
dataAccessConfig?: Schema$AdvertiserDataAccessConfig;
/**
* Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
*/
displayName?: string | null;
/**
* Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
*/
entityStatus?: string | null;
/**
* Required. General settings of the advertiser.
*/
generalConfig?: Schema$AdvertiserGeneralConfig;
/**
* Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
*/
integrationDetails?: Schema$IntegrationDetails;
/**
* Output only. The resource name of the advertiser.
*/
name?: string | null;
/**
* Required. Immutable. The unique ID of the partner that the advertiser belongs to.
*/
partnerId?: string | null;
/**
* Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
*/
prismaEnabled?: boolean | null;
/**
* Targeting settings related to ad serving of the advertiser.
*/
servingConfig?: Schema$AdvertiserTargetingConfig;
/**
* Output only. The timestamp when the advertiser was last updated. Assigned by the system.
*/
updateTime?: string | null;
}
/**
* Ad server related settings of an advertiser.
*/
export interface Schema$AdvertiserAdServerConfig {
/**
* The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
*/
cmHybridConfig?: Schema$CmHybridConfig;
/**
* The configuration for advertisers that use third-party ad servers only.
*/
thirdPartyOnlyConfig?: Schema$ThirdPartyOnlyConfig;
}
/**
* Billing related settings of an advertiser.
*/
export interface Schema$AdvertiserBillingConfig {
/**
* Required. The ID of a billing profile assigned to the advertiser.
*/
billingProfileId?: string | null;
}
/**
* Creatives related settings of an advertiser.
*/
export interface Schema$AdvertiserCreativeConfig {
/**
* Whether or not the advertiser is enabled for dynamic creatives.
*/
dynamicCreativeEnabled?: boolean | null;
/**
* An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
*/
iasClientId?: string | null;
/**
* Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
*/
obaComplianceDisabled?: boolean | null;
/**
* By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
*/
videoCreativeDataSharingAuthorized?: boolean | null;
}
/**
* Settings that control how advertiser related data may be accessed.
*/
export interface Schema$AdvertiserDataAccessConfig {
/**
* Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
*/
sdfConfig?: Schema$AdvertiserSdfConfig;
}
/**
* General settings of an advertiser.
*/
export interface Schema$AdvertiserGeneralConfig {
/**
* Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
*/
currencyCode?: string | null;
/**
* Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
*/
domainUrl?: string | null;
/**
* Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
*/
timeZone?: string | null;
}
/**
* Structured Data Files (SDF) settings of an advertiser.
*/
export interface Schema$AdvertiserSdfConfig {
/**
* Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
*/
overridePartnerSdfConfig?: boolean | null;
/**
* The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
*/
sdfConfig?: Schema$SdfConfig;
}
/**
* Targeting settings related to ad serving of an advertiser.
*/
export interface Schema$AdvertiserTargetingConfig {
/**
* Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
*/
exemptTvFromViewabilityTargeting?: boolean | null;
}
/**
* Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`.
*/
export interface Schema$AgeRangeAssignedTargetingOptionDetails {
/**
* Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
*/
ageRange?: string | null;
}
/**
* Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`.
*/
export interface Schema$AgeRangeTargetingOptionDetails {
/**
* Output only. The age range of an audience.
*/
ageRange?: string | null;
}
/**
* Rule-based algorithm.
*/
export interface Schema$AlgorithmRules {
/**
* Attribution model for the algorithm. This field is only supported for allowlisted partners.
*/
attributionModelId?: string | null;
/**
* Rules for the impression signals.
*/
impressionSignalRuleset?: Schema$AlgorithmRulesRuleset;
/**
* Rules for the post-impression signals. This field is only supported for allowlisted partners.
*/
postImpressionSignalRuleset?: Schema$AlgorithmRulesRuleset;
}
/**
* A value to compare the signal to.
*/
export interface Schema$AlgorithmRulesComparisonValue {
/**
* Boolean value.
*/
boolValue?: boolean | null;
/**
* Video content duration value.
*/
contentDurationValue?: string | null;
/**
* Video genre id value.
*/
contentGenreIdValue?: string | null;
/**
* Video delivery type value.
*/
contentStreamTypeValue?: string | null;
/**
* Creative dimension value.
*/
creativeDimensionValue?: Schema$Dimensions;
/**
* Day and time value. Only `TIME_ZONE_RESOLUTION_END_USER` is supported.
*/
dayAndTimeValue?: Schema$DayAndTime;
/**
* Device type value.
*/
deviceTypeValue?: string | null;
/**
* Double value.
*/
doubleValue?: number | null;
/**
* Environment value.
*/
environmentValue?: string | null;
/**
* Exchange value.
*/
exchangeValue?: string | null;
/**
* Integer value.
*/
int64Value?: string | null;
/**
* Ad position value.
*/
onScreenPositionValue?: string | null;
/**
* String value.
*/
stringValue?: string | null;
/**
* Video player size value. This field is only supported for allowlisted partners.
*/
videoPlayerSizeValue?: string | null;
}
/**
* The rule to score impressions based on Floodlight conversion events.
*/
export interface Schema$AlgorithmRulesFloodlightActivityConversionSignal {
/**
* Required. The type of conversions to be used in impression value computation, for example, post-click conversions.
*/
conversionCounting?: string | null;
/**
* Required. The way to acquire value from the floodlight activity, for example, count of the conversion.
*/
countingMethod?: string | null;
/**
* Required. Id of the floodlight activity.
*/
floodlightActivityId?: string | null;
}
/**
* Set of conditions. The return value of the rule is either: * The return value for single met condition or * The defined default return value if no conditions are met.
*/
export interface Schema$AlgorithmRulesRule {
/**
* List of conditions in this rule. The criteria among conditions should be mutually exclusive.
*/
conditions?: Schema$AlgorithmRulesRuleCondition[];
/**
* The default return value applied when none of the conditions are met.
*/
defaultReturnValue?: Schema$AlgorithmRulesSignalValue;
}
/**
* Set of signal comparisons. Equivalent of an `if` statement.
*/
export interface Schema$AlgorithmRulesRuleCondition {
/**
* The value returned if the `signalComparisons` condition evaluates to `TRUE`.
*/
returnValue?: Schema$AlgorithmRulesSignalValue;
/**
* List of comparisons that build `if` statement condition. The comparisons are combined into a single condition with `AND` logical operators.
*/
signalComparisons?: Schema$AlgorithmRulesSignalComparison[];
}
/**
* A ruleset consisting of a list of rules and how to aggregate the resulting values.
*/
export interface Schema$AlgorithmRulesRuleset {
/**
* How to aggregate values of evaluated rules.
*/
aggregationType?: string | null;
/**
* Maximum value the ruleset can evaluate to.
*/
maxValue?: number | null;
/**
* List of rules to generate the impression value.
*/
rules?: Schema$AlgorithmRulesRule[];
}
/**
* Signal used to evaluate rules.
*/
export interface Schema$AlgorithmRulesSignal {
/**
* Signal based on active views. This field is only supported for allowlisted partners.
*/
activeViewSignal?: string | null;
/**
* Signal based on clicks. This field is only supported for allowlisted partners.
*/
clickSignal?: string | null;
/**
* Signal based on impressions.
*/
impressionSignal?: string | null;
}
/**
* A single comparison. The comparison compares the `signal` to the `comparisonValue`. The comparison of `siteId==123` is represented with the following field values: * `signal` has an `impressionSignal` of `SITE_ID`. * `comparisonOperator` is set to `EQUAL`. * `comparisonValue` is set to 123.
*/
export interface Schema$AlgorithmRulesSignalComparison {
/**
* Operator used to compare the two values. In the resulting experession, the `signal` will be the first value and the `comparisonValue will be the second.
*/
comparisonOperator?: string | null;
/**
* Value to compare signal to.
*/
comparisonValue?: Schema$AlgorithmRulesComparisonValue;
/**
* Signal to compare.
*/
signal?: Schema$AlgorithmRulesSignal;
}
/**
* Adjusted value of the signal used for rule evaluation.
*/
export interface Schema$AlgorithmRulesSignalValue {
/**
* Signal based on active views. Only `TIME_ON_SCREEN` is supported. This field is only supported for allowlisted partners.
*/
activeViewSignal?: string | null;
/**
* Signal based on floodlight conversion events. This field is only supported for allowlisted partners.
*/
floodlightActivityConversionSignal?: Schema$AlgorithmRulesFloodlightActivityConversionSignal;
/**
* Value to use as result.
*/
number?: number | null;
}
/**
* Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`.
*/
export interface Schema$AppAssignedTargetingOptionDetails {
/**
* Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
*/
appId?: string | null;
/**
* Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
*/
appPlatform?: string | null;
/**
* Output only. The display name of the app.
*/
displayName?: string | null;
/**
* Indicates if this option is being negatively targeted.
*/
negative?: boolean | null;
}
/**
* Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
*/
export interface Schema$AppCategoryAssignedTargetingOptionDetails {
/**
* Output only. The display name of the app category.
*/
displayName?: string | null;
/**
* Indicates if this option is being negatively targeted.
*/
negative?: boolean | null;
/**
* Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
*/
targetingOptionId?: string | null;
}
/**
* Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
*/
export interface Schema$AppCategoryTargetingOptionDetails {
/**
* Output only. The name of the app collection.
*/
displayName?: string | null;
}
/**
* A single asset.
*/
export interface Schema$Asset {
/**
* The asset content. For uploaded assets, the content is the serving path.
*/
content?: string | null;
/**
* Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.
*/
mediaId?: string | null;
}
/**
* Asset association for the creative.
*/
export interface Schema$AssetAssociation {
/**
* Optional. The associated asset.
*/
asset?: Schema$Asset;
/**
* Optional. The role of this asset for the creative.
*/
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.
*/
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.
*/
targetingOptionId?: string | null;
}
/**
* A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
*/
export interface Schema$AssignedTargetingOption {
/**
* Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
*/
ageRangeDetails?: Schema$AgeRangeAssignedTargetingOptionDetails;
/**
* App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
*/
appCategoryDetails?: Schema$AppCategoryAssignedTargetingOptionDetails;
/**
* App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
*/
appDetails?: Schema$AppAssignedTargetingOptionDetails;
/**
* Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
*/
assignedTargetingOptionId?: string | null;
/**
* Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
*/
assignedTargetingOptionIdAlias?: string | null;
/**
* Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per reso