google-api-python-client 2.185.0__py3-none-any.whl → 2.187.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/dfareporting.v5.json

@@ -4675,11 +4675,81 @@
 "scopes": [
 "https://www.googleapis.com/auth/dfatrafficking"
 ]
+},
+"retransform": {
+"description": "Retransforms a dynamic feed.",
+"flatPath": "studio/dynamicFeeds/{dynamicFeedsId}/retransform",
+"httpMethod": "POST",
+"id": "dfareporting.dynamicFeeds.retransform",
+"parameterOrder": [
+"dynamicFeedId"
+],
+"parameters": {
+"dynamicFeedId": {
+"description": "Required. Dynamic feed ID.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "studio/dynamicFeeds/{+dynamicFeedId}/retransform",
+"response": {
+"$ref": "DynamicFeed"
+},
+"scopes": [
+"https://www.googleapis.com/auth/dfatrafficking"
+]
+},
+"update": {
+"description": "Updates a new dynamic feed.",
+"flatPath": "studio/dynamicFeeds",
+"httpMethod": "PUT",
+"id": "dfareporting.dynamicFeeds.update",
+"parameterOrder": [],
+"parameters": {},
+"path": "studio/dynamicFeeds",
+"request": {
+"$ref": "DynamicFeed"
+},
+"response": {
+"$ref": "DynamicFeed"
+},
+"scopes": [
+"https://www.googleapis.com/auth/dfatrafficking"
+]
 }
 }
 },
 "dynamicProfiles": {
 "methods": {
+"generateCode": {
+"description": "Generates code for a dynamic profile.",
+"flatPath": "studio/dynamicProfiles/{dynamicProfilesId}/generateCode",
+"httpMethod": "GET",
+"id": "dfareporting.dynamicProfiles.generateCode",
+"parameterOrder": [
+"dynamicProfileId"
+],
+"parameters": {
+"dynamicProfileId": {
+"description": "Required. Dynamic profile ID.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "studio/dynamicProfiles/{+dynamicProfileId}/generateCode",
+"response": {
+"$ref": "DynamicProfileGenerateCodeResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/dfatrafficking"
+]
+},
 "get": {
 "description": "Gets a dynamic profile by ID.",
 "flatPath": "studio/dynamicProfiles/{dynamicProfilesId}",
@@ -4724,6 +4794,29 @@
 "https://www.googleapis.com/auth/dfatrafficking"
 ]
 },
+"publish": {
+"description": "Publish for a dynamic profile.",
+"flatPath": "studio/dynamicProfiles/{dynamicProfilesId}/publish",
+"httpMethod": "POST",
+"id": "dfareporting.dynamicProfiles.publish",
+"parameterOrder": [
+"dynamicProfileId"
+],
+"parameters": {
+"dynamicProfileId": {
+"description": "Required. Dynamic profile ID.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "studio/dynamicProfiles/{+dynamicProfileId}/publish",
+"scopes": [
+"https://www.googleapis.com/auth/dfatrafficking"
+]
+},
 "update": {
 "description": "Updates an existing dynamic profile.",
 "flatPath": "studio/dynamicProfiles",
@@ -8662,6 +8755,112 @@
 }
 }
 },
+"studioCreativeAssets": {
+"methods": {
+"insert": {
+"description": "Inserts a new studio creative asset.",
+"flatPath": "studio/creativeAssets",
+"httpMethod": "POST",
+"id": "dfareporting.studioCreativeAssets.insert",
+"mediaUpload": {
+"accept": [
+"*/*"
+],
+"maxSize": "1073741824",
+"protocols": {
+"simple": {
+"multipart": true,
+"path": "/upload/dfareporting/v5/studio/creativeAssets"
+}
+}
+},
+"parameterOrder": [],
+"parameters": {},
+"path": "studio/creativeAssets",
+"request": {
+"$ref": "DfareportingStudioCreativeAssetsInsertRequest"
+},
+"response": {
+"$ref": "StudioCreativeAssetsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/dfatrafficking"
+],
+"supportsMediaUpload": true
+}
+}
+},
+"studioCreatives": {
+"methods": {
+"get": {
+"description": "Gets a studio creative by ID.",
+"flatPath": "studio/creatives/{creativesId}",
+"httpMethod": "GET",
+"id": "dfareporting.studioCreatives.get",
+"parameterOrder": [
+"studioCreativeId"
+],
+"parameters": {
+"studioCreativeId": {
+"description": "Required. Studio creative ID.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "studio/creatives/{+studioCreativeId}",
+"response": {
+"$ref": "StudioCreative"
+},
+"scopes": [
+"https://www.googleapis.com/auth/dfatrafficking"
+]
+},
+"insert": {
+"description": "Inserts a new studio creative.",
+"flatPath": "studio/creatives",
+"httpMethod": "POST",
+"id": "dfareporting.studioCreatives.insert",
+"parameterOrder": [],
+"parameters": {},
+"path": "studio/creatives",
+"request": {
+"$ref": "StudioCreative"
+},
+"response": {
+"$ref": "StudioCreative"
+},
+"scopes": [
+"https://www.googleapis.com/auth/dfatrafficking"
+]
+},
+"publish": {
+"description": "Publish for a studio creative.",
+"flatPath": "studio/creatives/{creativesId}/publish",
+"httpMethod": "POST",
+"id": "dfareporting.studioCreatives.publish",
+"parameterOrder": [
+"studioCreativeId"
+],
+"parameters": {
+"studioCreativeId": {
+"description": "Required. Studio creative ID.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "studio/creatives/{+studioCreativeId}/publish",
+"scopes": [
+"https://www.googleapis.com/auth/dfatrafficking"
+]
+}
+}
+},
 "subaccounts": {
 "methods": {
 "get": {
@@ -9806,7 +10005,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20251023",
 "rootUrl": "https://dfareporting.googleapis.com/",
 "schemas": {
 "Account": {
@@ -10330,6 +10529,10 @@
 ],
 "type": "string"
 },
+"contextualKeywordTargeting": {
+"$ref": "ContextualKeywordTargeting",
+"description": "Optional. Contextual keyword targeting information for this ad."
+},
 "createInfo": {
 "$ref": "LastModifiedInfo",
 "description": "Information about the creation of this ad. This is a read-only field."
@@ -11858,6 +12061,31 @@
 },
 "type": "object"
 },
+"ContextualKeyword": {
+"description": "Contains information about a Contextual Keyword that can be targeted by ads.",
+"id": "ContextualKeyword",
+"properties": {
+"keyword": {
+"description": "The keyword that can be targeted by ads.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ContextualKeywordTargeting": {
+"description": "Contextual Keyword Targeting.",
+"id": "ContextualKeywordTargeting",
+"properties": {
+"keywords": {
+"description": "Contextual keywords that this ad targets",
+"items": {
+"$ref": "ContextualKeyword"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "Conversion": {
 "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
 "id": "Conversion",
@@ -12234,14 +12462,24 @@
 "CREATIVE_AUTHORING_SOURCE_DBM",
 "CREATIVE_AUTHORING_SOURCE_STUDIO",
 "CREATIVE_AUTHORING_SOURCE_GWD",
-"CREATIVE_AUTHORING_SOURCE_ACS"
+"CREATIVE_AUTHORING_SOURCE_ACS",
+"CREATIVE_AUTHORING_SOURCE_ADOBE",
+"CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI",
+"CREATIVE_AUTHORING_SOURCE_REMBRAND",
+"CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO",
+"CREATIVE_AUTHORING_SOURCE_BORNLOGIC"
 ],
 "enumDescriptions": [
 "DCM-UI or external API used to author the creative.",
 "DBM-UI used to author the creative.",
 "Studio-UI used to author the creative.",
 "Google Web Designer used to author the creative.",
-"ACS-UI used to author the creative."
+"ACS-UI used to author the creative.",
+"Creative authoring source is Adobe.",
+"Creative authoring source is Typeface.ai.",
+"Creative authoring source is Rembrand.",
+"Creative authoring source is Trackto.",
+"Creative authoring source is Bornlogic."
 ],
 "type": "string"
 },
@@ -14641,6 +14879,28 @@
 },
 "type": "object"
 },
+"DfareportingStudioCreativeAssetsInsertRequest": {
+"description": "Request message for DfareportingStudioCreativeAssets.Insert.",
+"id": "DfareportingStudioCreativeAssetsInsertRequest",
+"properties": {
+"studioAccountId": {
+"description": "Optional. Studio account ID of the studio creative asset. It is a optional.",
+"format": "int64",
+"type": "string"
+},
+"studioAdvertiserId": {
+"description": "Required. Studio advertiser ID of the studio creative asset. It is a required field on insertion.",
+"format": "int64",
+"type": "string"
+},
+"studioCreativeId": {
+"description": "Optional. Studio creative ID of the studio creative asset. It is a optional field. If it is set, the asset will be associated to the creative.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "DfpSettings": {
 "description": "Google Ad Manager Settings",
 "id": "DfpSettings",
@@ -14992,7 +15252,7 @@
 "type": "object"
 },
 "DynamicFeedsInsertRequest": {
-"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See go/cm3-dco-display-api-interface",
+"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See",
 "id": "DynamicFeedsInsertRequest",
 "properties": {
 "dynamicFeed": {
@@ -15107,6 +15367,17 @@
 },
 "type": "object"
 },
+"DynamicProfileGenerateCodeResponse": {
+"description": "Response message for DfareportingDynamicProfiles.GenerateCode.",
+"id": "DynamicProfileGenerateCodeResponse",
+"properties": {
+"code": {
+"description": "Generated code for the dynamic profile.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "DynamicProfileVersion": {
 "description": "Contains dynamic profile version information.",
 "id": "DynamicProfileVersion",
@@ -16127,7 +16398,7 @@
 "User visiting a page.",
 "Software download action (as for an app). A conversion type that is created as a download type may not have its category changed.",
 "Boom event (for user list creation). This is an internal-only category.",
-"The following are conversion categories added as part of go/new-categories-prd. The addition of items to a shopping cart or bag on an advertiser site.",
+". The addition of items to a shopping cart or bag on an advertiser site.",
 "When someone enters the checkout flow on an advertiser site.",
 "The start of a paid subscription for a product or service.",
 "The start of a free subscription for a product or service.",
@@ -16140,12 +16411,12 @@
 "A click to an advertiser's partner site, e.g. a referral.",
 "A call, SMS, email, chat or other type of contact to an advertiser.",
 "Key page views (ex: product page, article).",
-"A website engagement event such as long site time or a GA Smart Goal, intended to be used for GA, Firebase, GA Gold goal imports. This will also be used for YouTube Hosted engagements like Add To Playlist, Likes etc. See go/add-to-playlist-conversion-buyside",
+"A website engagement event",
 "A visit to a physical store location.",
 "A sale occurring in a physical store.",
-"End of new conversion categories from go/new-categories-prd. A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser.",
+"A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser.",
 "A lead conversion imported from an external source into Google Ads, that has further completed a desired stage as defined by the lead gen advertiser.",
-"Conversion event that provides the revenue value of impressions that were shown in-app to users. See go/ad-impression-type.",
+"Conversion event that provides the revenue value of impressions that were shown in-app to users.",
 "Message exchanges which indicate an interest in an advertiser's offering."
 ],
 "type": "string"
@@ -18037,7 +18308,7 @@
 "type": "boolean"
 },
 "adServingPlatformId": {
-"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv",
+"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint",
 "format": "int64",
 "type": "string"
 },
@@ -19842,7 +20113,7 @@
 "type": "string"
 },
 "adServingPlatformId": {
-"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv",
+"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint",
 "format": "int64",
 "type": "string"
 },
@@ -20232,6 +20503,207 @@
 },
 "type": "object"
 },
+"StudioCreative": {
+"description": "Contains studio creative information.",
+"id": "StudioCreative",
+"properties": {
+"assetIds": {
+"description": "List of assets associated with this studio creative. It is a required field on insertion.",
+"items": {
+"format": "int64",
+"type": "string"
+},
+"type": "array"
+},
+"backupImageAssetId": {
+"description": "Backup image asset ID of this studio creative.",
+"format": "int64",
+"type": "string"
+},
+"createdInfo": {
+"$ref": "LastModifiedInfo",
+"description": "The timestamp when the studio creative was created. This is a read-only, auto-generated field."
+},
+"dimension": {
+"$ref": "StudioCreativeDimension",
+"description": "Dimension of this studio creative. This is a required field on insertion if format is BANNER or EXPANDING."
+},
+"dynamicProfileId": {
+"description": "Dynamic profile ID of this studio creative.",
+"format": "int64",
+"type": "string"
+},
+"format": {
+"description": "Format of this studio creative. This is a required field on insertion.",
+"enum": [
+"UNKNOWN",
+"BANNER",
+"EXPANDING",
+"INTERSTITIAL",
+"VPAID_LINEAR_VIDEO"
+],
+"enumDescriptions": [
+"The format of the studio creative is unknown. This value is unused.",
+"Banner format.",
+"Expanding format.",
+"Intertitial format.",
+"VPAID linear video creative format."
+],
+"type": "string"
+},
+"id": {
+"description": "Output only. Unique ID of this studio creative. This is a read-only, auto-generated field.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"lastModifiedInfo": {
+"$ref": "LastModifiedInfo",
+"description": "The timestamp when the studio creative was last modified. This is a read-only, auto-generated field."
+},
+"name": {
+"description": "Identifier. Name of this studio creative. This is a required field on insertion.",
+"type": "string"
+},
+"status": {
+"description": "Output only. Status of this studio creative. It is a read-only field.",
+"enum": [
+"UNKNOWN_STATUS",
+"IN_DEVELOPMENT",
+"PUBLISHED",
+"QA_REJECTED",
+"QA_APPROVED",
+"TRAFFICKED"
+],
+"enumDescriptions": [
+"The status of the studio creative is unknown. This value is unused.",
+"The creative is still being developed.",
+"The creative has been published and is ready for QA.",
+"The creative has failed QA and must be corrected.",
+"The creative has passed QA and is ready to be trafficked.",
+"The creative has been trafficked to an adserver."
+],
+"readOnly": true,
+"type": "string"
+},
+"studioAccountId": {
+"description": "Studio account ID of this creative. This field, if left unset, will be auto-populated.",
+"format": "int64",
+"type": "string"
+},
+"studioAdvertiserId": {
+"description": "Studio advertiser ID of this studio creative. This is a required field on insertion.",
+"format": "int64",
+"type": "string"
+},
+"studioCampaignId": {
+"description": "Studio campaign ID of this studio creative. This is a required field on insertion.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"StudioCreativeAsset": {
+"description": "Contains studio creative asset information.",
+"id": "StudioCreativeAsset",
+"properties": {
+"createInfo": {
+"$ref": "LastModifiedInfo",
+"description": "Output only. The creation timestamp of the studio creative asset. This is a read-only field.",
+"readOnly": true
+},
+"filename": {
+"description": "The filename of the studio creative asset. It is default to the original filename of the asset.",
+"type": "string"
+},
+"filesize": {
+"description": "The filesize of the studio creative asset. This is a read-only field.",
+"format": "int64",
+"type": "string"
+},
+"id": {
+"description": "Output only. Unique ID of this studio creative asset. This is a read-only, auto-generated field.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"lastModifiedInfo": {
+"$ref": "LastModifiedInfo",
+"description": "Output only. The last modified timestamp of the studio creative asset. This is a read-only field.",
+"readOnly": true
+},
+"studioAccountId": {
+"description": "Studio account ID of this studio creative asset. This field, if left unset, will be auto-populated..",
+"format": "int64",
+"type": "string"
+},
+"studioAdvertiserId": {
+"description": "Studio advertiser ID of this studio creative asset. This is a required field on insertion.",
+"format": "int64",
+"type": "string"
+},
+"studioCreativeId": {
+"description": "Studio creative ID of this studio creative asset. The asset will be associated to the creative if creative id is set.",
+"format": "int64",
+"type": "string"
+},
+"type": {
+"description": "The type of the studio creative asset. It is a auto-generated, read-only field.",
+"enum": [
+"UNKNOWN_TYPE",
+"HTML",
+"VIDEO",
+"IMAGE",
+"FONT"
+],
+"enumDescriptions": [
+"Unknown type of asset.",
+"The asset is an HTML file.",
+"The asset is a video file.",
+"The asset is an image file.",
+"The asset is a font file."
+],
+"type": "string"
+},
+"videoProcessingData": {
+"$ref": "VideoProcessingData",
+"description": "The processing data of the studio creative asset. This is a read-only field."
+}
+},
+"type": "object"
+},
+"StudioCreativeAssetsResponse": {
+"description": "Response message for DfareportingStudioCreativeAssets.Insert.",
+"id": "StudioCreativeAssetsResponse",
+"properties": {
+"assets": {
+"description": "The list of studio creative assets.",
+"items": {
+"$ref": "StudioCreativeAsset"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"StudioCreativeDimension": {
+"description": "Dimension information for a studio creative.",
+"id": "StudioCreativeDimension",
+"properties": {
+"height": {
+"description": "Height of the studio creative.",
+"format": "int32",
+"type": "integer"
+},
+"width": {
+"description": "Width of the studio creative.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "Subaccount": {
 "description": "Contains properties of a Campaign Manager subaccount.",
 "id": "Subaccount",
@@ -20564,6 +21036,10 @@
 "$ref": "DimensionValue",
 "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
 },
+"contextualKeywordTargeting": {
+"$ref": "ContextualKeywordTargeting",
+"description": "Optional. Contextual keyword targeting criteria."
+},
 "dayPartTargeting": {
 "$ref": "DayPartTargeting",
 "description": "Time and day targeting criteria."
@@ -20916,13 +21392,15 @@
 "AD_ID_OFFICIAL",
 "CLEARCAST",
 "DCM",
-"ARPP"
+"ARPP",
+"CUSV"
 ],
 "enumDescriptions": [
 "",
 "",
 "",
 "",
+"",
 ""
 ],
 "type": "string"
@@ -21495,6 +21973,34 @@
 },
 "type": "object"
 },
+"VideoProcessingData": {
+"description": "Contains processing data for a video asset.",
+"id": "VideoProcessingData",
+"properties": {
+"errorReason": {
+"description": "For a FAILED processing state, the error reason discovered.",
+"type": "string"
+},
+"processingState": {
+"description": "Output only. The processing state of the studio creative asset.",
+"enum": [
+"UNKNOWN",
+"PROCESSING",
+"SUCCEEDED",
+"FAILED"
+],
+"enumDescriptions": [
+"The processing state is unknown.",
+"The asset is being processed.",
+"The asset was successfully processed.",
+"The asset failed to be processed."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "VideoSettings": {
 "description": "Video Settings",
 "id": "VideoSettings",