{ "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/authorized-buyers-marketplace": { "description": "See, create, edit, and delete your Authorized Buyers Marketplace entities." } } } }, "description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", "discoveryVersion": "v1", "version": "v1beta", "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", "resources": { "curators": { "resources": { "curatedPackages": { "methods": { "patch": { "flatPath": "v1beta/curators/{curatorsId}/curatedPackages/{curatedPackagesId}", "path": "v1beta/{+name}", "httpMethod": "PATCH", "response": { "$ref": "CuratedPackage" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Updates an existing curated package.", "id": "authorizedbuyersmarketplace.curators.curatedPackages.patch", "parameters": { "name": { "required": true, "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", "location": "path", "type": "string" }, "updateMask": { "description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "request": { "$ref": "CuratedPackage" } }, "get": { "parameterOrder": [ "name" ], "description": "Gets a curated package given its resource name.", "id": "authorizedbuyersmarketplace.curators.curatedPackages.get", "parameters": { "name": { "required": true, "description": "Required. The name of the curated package to retrieve. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", "location": "path", "type": "string" } }, "flatPath": "v1beta/curators/{curatorsId}/curatedPackages/{curatedPackagesId}", "path": "v1beta/{+name}", "httpMethod": "GET", "response": { "$ref": "CuratedPackage" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "create": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^curators/[^/]+$", "required": true, "description": "Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}`", "location": "path", "type": "string" } }, "request": { "$ref": "CuratedPackage" }, "description": "Creates a new curated package.", "id": "authorizedbuyersmarketplace.curators.curatedPackages.create", "flatPath": "v1beta/curators/{curatorsId}/curatedPackages", "httpMethod": "POST", "response": { "$ref": "CuratedPackage" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1beta/{+parent}/curatedPackages" }, "activate": { "parameterOrder": [ "name" ], "id": "authorizedbuyersmarketplace.curators.curatedPackages.activate", "description": "Activates an existing curated package.", "request": { "$ref": "ActivateCuratedPackageRequest" }, "parameters": { "name": { "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", "description": "Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1beta/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:activate", "path": "v1beta/{+name}:activate", "httpMethod": "POST", "response": { "$ref": "CuratedPackage" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "list": { "parameters": { "pageSize": { "location": "query", "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", "type": "integer", "format": "int32" }, "filter": { "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos", "type": "string", "location": "query" }, "parent": { "type": "string", "location": "path", "description": "Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId}`", "required": true, "pattern": "^curators/[^/]+$" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page.", "type": "string" } }, "id": "authorizedbuyersmarketplace.curators.curatedPackages.list", "description": "Lists curated packages owned by the specified curator.", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "ListCuratedPackagesResponse" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1beta/{+parent}/curatedPackages", "flatPath": "v1beta/curators/{curatorsId}/curatedPackages" }, "deactivate": { "flatPath": "v1beta/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:deactivate", "path": "v1beta/{+name}:deactivate", "httpMethod": "POST", "response": { "$ref": "CuratedPackage" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "id": "authorizedbuyersmarketplace.curators.curatedPackages.deactivate", "description": "Deactivates an existing curated package.", "request": { "$ref": "DeactivateCuratedPackageRequest" }, "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "pattern": "^curators/[^/]+/curatedPackages/[^/]+$" } } } } }, "dataSegments": { "methods": { "patch": { "parameterOrder": [ "name" ], "description": "Updates a data segment.", "id": "authorizedbuyersmarketplace.curators.dataSegments.patch", "parameters": { "name": { "pattern": "^curators/[^/]+/dataSegments/[^/]+$", "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`", "required": true, "type": "string", "location": "path" }, "updateMask": { "description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "request": { "$ref": "DataSegment" }, "flatPath": "v1beta/curators/{curatorsId}/dataSegments/{dataSegmentsId}", "path": "v1beta/{+name}", "httpMethod": "PATCH", "response": { "$ref": "DataSegment" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "get": { "parameterOrder": [ "name" ], "description": "Gets a data segment given its name.", "id": "authorizedbuyersmarketplace.curators.dataSegments.get", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^curators/[^/]+/dataSegments/[^/]+$", "required": true, "description": "Required. Name of data segment to get. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`" } }, "flatPath": "v1beta/curators/{curatorsId}/dataSegments/{dataSegmentsId}", "path": "v1beta/{+name}", "httpMethod": "GET", "response": { "$ref": "DataSegment" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "create": { "parameterOrder": [ "parent" ], "request": { "$ref": "DataSegment" }, "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^curators/[^/]+$", "required": true, "description": "Required. The parent resource where this data segment will be created. v1alpha format: `buyers/{accountId}` v1beta format: `curators/{accountId}`" } }, "id": "authorizedbuyersmarketplace.curators.dataSegments.create", "description": "Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.", "flatPath": "v1beta/curators/{curatorsId}/dataSegments", "httpMethod": "POST", "response": { "$ref": "DataSegment" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1beta/{+parent}/dataSegments" }, "activate": { "parameterOrder": [ "name" ], "id": "authorizedbuyersmarketplace.curators.dataSegments.activate", "description": "Activates a data segment.", "request": { "$ref": "ActivateDataSegmentRequest" }, "parameters": { "name": { "pattern": "^curators/[^/]+/dataSegments/[^/]+$", "description": "Required. Name of data segment to activate. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1beta/curators/{curatorsId}/dataSegments/{dataSegmentsId}:activate", "path": "v1beta/{+name}:activate", "httpMethod": "POST", "response": { "$ref": "DataSegment" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "list": { "flatPath": "v1beta/curators/{curatorsId}/dataSegments", "path": "v1beta/{+parent}/dataSegments", "httpMethod": "GET", "response": { "$ref": "ListDataSegmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "parent" ], "description": "List the data segments owned by a curator.", "id": "authorizedbuyersmarketplace.curators.dataSegments.list", "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^curators/[^/]+$", "description": "Required. Name of the parent curator that can access the data segment. v1alpha format: `buyers/{accountId}` v1beta format: `curators/{accountId}`", "required": true }, "pageToken": { "description": "Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken", "type": "string", "location": "query" }, "pageSize": { "location": "query", "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", "type": "integer", "format": "int32" } } }, "deactivate": { "path": "v1beta/{+name}:deactivate", "httpMethod": "POST", "response": { "$ref": "DataSegment" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1beta/curators/{curatorsId}/dataSegments/{dataSegmentsId}:deactivate", "description": "Deactivates a data segment.", "id": "authorizedbuyersmarketplace.curators.dataSegments.deactivate", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^curators/[^/]+/dataSegments/[^/]+$", "required": true, "description": "Required. Name of data segment to deactivate. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`" } }, "request": { "$ref": "DeactivateDataSegmentRequest" }, "parameterOrder": [ "name" ] } } } } }, "mediaPlanners": { "methods": { "list": { "httpMethod": "GET", "response": { "$ref": "ListMediaPlannersResponse" }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1beta/mediaPlanners", "flatPath": "v1beta/mediaPlanners", "parameters": { "pageSize": { "location": "query", "description": "The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500.", "type": "integer", "format": "int32" }, "filter": { "description": "Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames`", "type": "string", "location": "query" }, "pageToken": { "description": "A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken.", "type": "string", "location": "query" } }, "description": "Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error.", "id": "authorizedbuyersmarketplace.mediaPlanners.list", "parameterOrder": [] } } } }, "basePath": "", "parameters": { "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "key": { "location": "query", "type": "string", "description": "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." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "alt": { "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "location": "query" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "prettyPrint": { "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "$.xgafv": { "location": "query", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "description": "V1 error format." }, "quotaUser": { "type": "string", "description": "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.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" } }, "fullyEncodeReservedExpansion": true, "protocol": "rest", "id": "authorizedbuyersmarketplace:v1beta", "baseUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "canonicalName": "Authorized Buyers Marketplace", "revision": "20260414", "ownerName": "Google", "title": "Authorized Buyers Marketplace API", "kind": "discovery#restDescription", "version_module": true, "ownerDomain": "google.com", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "batchPath": "batch", "servicePath": "", "mtlsRootUrl": "https://authorizedbuyersmarketplace.mtls.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "schemas": { "VideoPlcmtTargeting": { "id": "VideoPlcmtTargeting", "description": "Defines targeting criteria based on the video placement type, often corresponding to the IAB OpenRTB 'plcmt' field.", "type": "object", "properties": { "selectionType": { "enumDescriptions": [ "Unspecified selection type. Should not be used.", "The values in the targeting dimension are included.", "The values in the targeting dimension are excluded." ], "description": "Required. The selection type for the list of video plcmts.", "type": "string", "enum": [ "SELECTION_TYPE_UNSPECIFIED", "SELECTION_TYPE_INCLUDE", "SELECTION_TYPE_EXCLUDE" ] }, "videoPlcmtTypes": { "description": "Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type.", "type": "array", "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Pre-roll, mid-roll, and post-roll ads that are played before, during or after the streaming video content that the consumer has requested. Instream video must be set to “sound on” by default at player start, or have explicitly clear user intent to watch the video content. While there may be other content surrounding the player, the video content must be the focus of the user’s visit. It should remain the primary content on the page and the only video player in-view capable of audio when playing. If the player converts to floating/sticky, subsequent ad calls should accurately convey the updated player size.", "Pre-roll, mid-roll, and post-roll ads that are played before, during, or after streaming video content. The video player loads and plays before, between, or after paragraphs of text or graphical content, and starts playing only when it enters the viewport. Accompanying content should only start playback upon entering the viewport. It may convert to a floating/sticky player as it scrolls off the page.", "Video ads that are played without video content. During playback, it must be the primary focus of the page and take up the majority of the viewport and cannot be scrolled out of view. This can be in placements like in-app video or slideshows.", "Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating." ], "enum": [ "VIDEO_PLCMT_TYPE_UNSPECIFIED", "INSTREAM", "ACCOMPANYING_CONTENT", "INTERSTITIAL", "NO_CONTENT" ], "type": "string" } } } }, "PackageVideoTargeting": { "properties": { "includedPlaybackMethods": { "description": "Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method.", "type": "array", "items": { "type": "string", "enum": [ "PLAYBACK_METHOD_UNSPECIFIED", "PLAYBACK_METHOD_AUTO_PLAY_SOUND_ON", "PLAYBACK_METHOD_AUTO_PLAY_SOUND_OFF", "PLAYBACK_METHOD_CLICK_TO_PLAY" ], "enumDescriptions": [ "Unspecified video playback method. Should not be used.", "Playback starts automatically when the page/content loads.", "Playback starts automatically when the page/content loads, but with sound off.", "Playback is initiated by a user action (e.g., clicking a play button)." ] } }, "includedPositionTypes": { "items": { "type": "string", "enum": [ "POSITION_TYPE_UNSPECIFIED", "POSITION_TYPE_MIDROLL", "POSITION_TYPE_POSTROLL", "POSITION_TYPE_PREROLL" ], "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "The ad is played in the middle of the video content.", "The ad is played after the video content.", "The ad is played before the video content." ] }, "description": "Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type.", "type": "array" }, "includedMimeTypes": { "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "3GPP container format used on 3G phones.", "HLS/M3U8", "MPEG-4 container typically with H.264 codec.", "DASH.", "JavaScript (used for VPAID ads).", "WebM container assuming VP9 codec." ], "type": "string", "enum": [ "VIDEO_MIME_TYPE_UNSPECIFIED", "VIDEO_MIME_TYPE_THREEGPP", "VIDEO_MIME_TYPE_APPLICATION_MPEGURL", "VIDEO_MIME_TYPE_MP4", "VIDEO_MIME_TYPE_APPLICATION_MPEGDASH", "VIDEO_MIME_TYPE_APPLICATION_JAVASCRIPT", "VIDEO_MIME_TYPE_WEBM" ] }, "description": "Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type.", "type": "array" }, "minimumPredictedCompletionRatePercentage": { "description": "Optional. The targeted minimum predicted completion rate percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate. An unset value indicates inventory will be targeted regardless of predicted completion rate.", "type": "string", "format": "int64" }, "includedContentDeliveryMethod": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets video content that is being broadcast live.", "Targets video content that is transferred incrementally as client's playback requires." ], "enum": [ "CONTENT_DELIVERY_METHOD_UNSPECIFIED", "CONTENT_DELIVERY_METHOD_STREAMING", "CONTENT_DELIVERY_METHOD_PROGRESSIVE" ], "description": "Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method.", "type": "string" }, "plcmtTargeting": { "description": "Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type.", "$ref": "VideoPlcmtTargeting" }, "includedMaximumAdDurationTargeting": { "enum": [ "MAXIMUM_VIDEO_AD_DURATION_UNSPECIFIED", "MAXIMUM_VIDEO_AD_DURATION_FIFTEEN_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_TWENTY_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_THIRTY_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_SIXTY_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_NINETY_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_ONE_HUNDRED_TWENTY_SECONDS" ], "description": "Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration.", "type": "string", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Applies to video ads with a duration up to 15 seconds (0 \u003c duration \u003c= 15s).", "Applies to video ads with a duration up to 20 seconds (0 \u003c duration \u003c= 20s).", "Applies to video ads with a duration up to 30 seconds (0 \u003c duration \u003c= 30s).", "Applies to video ads with a duration up to 60 seconds (0 \u003c duration \u003c= 60s).", "Applies to video ads with a duration up to 90 seconds (0 \u003c duration \u003c= 90s).", "Applies to video ads with a duration up to 120 seconds (0 \u003c duration \u003c= 120s)." ] }, "includedPlayerSizeTargeting": { "description": "Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size.", "$ref": "VideoPlayerSizeTargeting" } }, "id": "PackageVideoTargeting", "description": "Video specific targeting criteria.", "type": "object" }, "PackagePublisherProvidedSignalsTargeting": { "id": "PackagePublisherProvidedSignalsTargeting", "description": "Represents targeting about publisher provided signals. Different publisher provided signals types will be logically OR'ed.", "type": "object", "properties": { "audienceTargeting": { "description": "Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv)", "$ref": "TaxonomyTargeting" }, "contentTargeting": { "description": "Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv)", "$ref": "TaxonomyTargeting" }, "videoAndAudioSignalsTargeting": { "description": "Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals.", "$ref": "StringTargetingDimension" } } }, "AdSize": { "id": "AdSize", "description": "Represents size of a single ad slot, or a creative.", "type": "object", "properties": { "width": { "description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", "type": "string", "format": "int64" }, "type": { "enumDescriptions": [ "A placeholder for an undefined size type.", "Ad slot with size specified by height and width in pixels.", "Special size to describe an interstitial ad slot.", "Native (mobile) ads rendered by the publisher.", "Fluid size (responsive size) can be resized automatically with the change of outside environment." ], "description": "The type of the ad slot size.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PIXEL", "INTERSTITIAL", "NATIVE", "FLUID" ] }, "height": { "description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", "type": "string", "format": "int64" } } }, "DeactivateCuratedPackageRequest": { "properties": {}, "description": "Request message for DeactivateCuratedPackage.", "type": "object", "id": "DeactivateCuratedPackageRequest" }, "DeactivateDataSegmentRequest": { "properties": {}, "description": "Request message for deactivating a data segment", "type": "object", "id": "DeactivateDataSegmentRequest" }, "AccessControlSettings": { "id": "AccessControlSettings", "description": "Settings for controlling access to a curated package.", "type": "object", "properties": { "allowlistedMediaPlanners": { "description": "Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time. Format: `mediaPlanners/{mediaPlannerAccountId}`", "type": "array", "items": { "type": "string" } } } }, "ActivateDataSegmentRequest": { "description": "Request message for activating a data segment", "type": "object", "id": "ActivateDataSegmentRequest", "properties": {} }, "VideoPlayerSizeTargeting": { "properties": { "minimumHeight": { "description": "Required. The minimum height of the video player in pixels.", "type": "string", "format": "int64" }, "minimumWidth": { "description": "Required. The minimum width of the video player in pixels.", "type": "string", "format": "int64" } }, "id": "VideoPlayerSizeTargeting", "description": "Represents the size of the video player that can be targeted. Both width and height are required to be set to non-zero values.", "type": "object" }, "PackageTargeting": { "id": "PackageTargeting", "description": "Targeting criteria for curated and auction packages.", "type": "object", "properties": { "minimumPredictedClickThroughRatePercentageMillis": { "description": "Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate. An unset value indicates inventory will be targeted regardless of predicted click through rate.", "type": "string", "format": "int64" }, "includedRestrictedCategories": { "description": "Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories.", "type": "array", "items": { "type": "string", "enum": [ "RESTRICTED_CATEGORY_UNSPECIFIED", "RESTRICTED_CATEGORY_ALCOHOL", "RESTRICTED_CATEGORY_GAMBLING" ], "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory where alcohol ads are allowed by the publisher.", "Targets inventory where gambling ads are allowed by the publisher." ] } }, "includedAcceleratedMobilePageType": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory on standard web pages not using any AMP framework.", "Targets inventory on pages built using the core AMP HTML framework.", "Targets inventory on pages using the AMP Story (STAMP) format, which is optimized for visual storytelling (e.g., tappable full-screen experiences)." ], "enum": [ "ACCELERATED_MOBILE_PAGE_TYPE_UNSPECIFIED", "ACCELERATED_MOBILE_PAGE_TYPE_NON_AMP", "ACCELERATED_MOBILE_PAGE_TYPE_AMP", "ACCELERATED_MOBILE_PAGE_TYPE_AMP_STORY" ], "description": "Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status.", "type": "string" }, "videoTargeting": { "description": "Optional. Video specific targeting criteria.", "$ref": "PackageVideoTargeting" }, "includedDataSegments": { "items": { "type": "string" }, "description": "Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: `curators/{account_id}/dataSegments/{data_segment_id}`", "type": "array" }, "minimumPredictedViewabilityPercentage": { "description": "Optional. The targeted minimum predicted viewability percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability. An unset value indicates inventory will be targeted regardless of predicted viewability.", "type": "string", "format": "int64" }, "includedRewardedType": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory that does NOT offer an explicit reward to the user for watching or interacting with the ad.", "Targets inventory that offers a reward to the user in exchange for watching or engaging with the ad." ], "description": "Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type.", "type": "string", "enum": [ "REWARDED_TYPE_UNSPECIFIED", "REWARDED_TYPE_NON_REWARDED", "REWARDED_TYPE_REWARDED" ] }, "languageTargeting": { "description": "Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes.", "$ref": "StringTargetingDimension" }, "placementTargeting": { "description": "Optional. Placement targeting information, for example, URL, mobile applications.", "$ref": "PackagePlacementTargeting" }, "includedOpenMeasurementTypes": { "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory that supports the v1 Open Measurement Interface Definition (OMID)." ], "type": "string", "enum": [ "OPEN_MEASUREMENT_TYPE_UNSPECIFIED", "OPEN_MEASUREMENT_TYPE_OMID_V1" ] }, "description": "Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support.", "type": "array" }, "includedEnvironment": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory rendered within an ad-supported website.", "Targets inventory within a mobile application." ], "description": "Optional. The environment to target. If unspecified, all environments are targeted.", "type": "string", "enum": [ "ENVIRONMENT_UNSPECIFIED", "ENVIRONMENT_SITE", "ENVIRONMENT_APP" ] }, "includedNativeInventoryTypes": { "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets ad slots that *only* accept and render native ads.", "Targets ad slots that accept and render either native or banner ads." ], "enum": [ "NATIVE_INVENTORY_TYPE_UNSPECIFIED", "NATIVE_INVENTORY_TYPE_NATIVE_ONLY", "NATIVE_INVENTORY_TYPE_NATIVE_OR_BANNER" ], "type": "string" }, "description": "Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type.", "type": "array" }, "verticalTargeting": { "description": "Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical.", "$ref": "CriteriaTargeting" }, "publisherProvidedSignalsTargeting": { "description": "Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals.", "$ref": "PackagePublisherProvidedSignalsTargeting" }, "includedAdSizes": { "items": { "$ref": "AdSize" }, "description": "Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size. Curated packages supports `PIXEL` and `INTERSTITIAL` ad sizes.", "type": "array" }, "includedCreativeFormat": { "description": "Optional. The creative format to target. If unset, all creative markup types are targeted.", "type": "string", "enum": [ "CREATIVE_FORMAT_UNSPECIFIED", "CREATIVE_FORMAT_DISPLAY", "CREATIVE_FORMAT_VIDEO", "CREATIVE_FORMAT_AUDIO" ], "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets ad slots intended for HTML display creatives.", "Targets ad slots intended for video creatives.", "Targets ad slots intended for audio creatives." ] }, "publisherTargeting": { "description": "Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.", "$ref": "StringTargetingDimension" }, "includedDeviceTypes": { "description": "Optional. The list of included device types to target. If empty, all device types are targeted.", "type": "array", "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets desktop or laptop computers.", "Targets connected TVs: devices that stream TV content, including smart TVs, gaming consoles, and streaming boxes/sticks.", "Targets high-end mobile devices.", "Targets tablet devices." ], "enum": [ "DEVICE_TYPE_UNSPECIFIED", "DEVICE_TYPE_PERSONAL_COMPUTER", "DEVICE_TYPE_CONNECTED_TV", "DEVICE_TYPE_PHONE", "DEVICE_TYPE_TABLET" ], "type": "string" } }, "includedAuthorizedSellerStatuses": { "description": "Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status.", "type": "array", "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory where the seller is declared as 'DIRECT'. This indicates the publisher (content owner) directly controls the seller account and has a direct business contract with the advertising system for this account.", "Targets inventory where the seller is declared as 'RESELLER'. This indicates the publisher has authorized another entity to operate the listed seller account and resell their ad space." ], "enum": [ "AUTHORIZED_SELLER_STATUS_UNSPECIFIED", "AUTHORIZED_SELLER_STATUS_DIRECT", "AUTHORIZED_SELLER_STATUS_RESELLER" ], "type": "string" } }, "geoTargeting": { "description": "Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo.", "$ref": "CriteriaTargeting" } } }, "ListDataSegmentsResponse": { "description": "Response message for listing data segments.", "type": "object", "id": "ListDataSegmentsResponse", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results.", "type": "string" }, "dataSegments": { "items": { "$ref": "DataSegment" }, "description": "The list of data segments.", "type": "array" } } }, "ListMediaPlannersResponse": { "description": "A response containing media planner account information.", "type": "object", "id": "ListMediaPlannersResponse", "properties": { "mediaPlanners": { "description": "List of media planners.", "type": "array", "items": { "$ref": "MediaPlanner" } }, "nextPageToken": { "description": "A token which can be passed to a subsequent call to the `ListMediaPlanners` method to retrieve the next page of results in ListMediaPlannersRequest.pageToken.", "type": "string" } } }, "MediaPlanner": { "properties": { "name": { "description": "Identifier. The unique resource name of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response of the mediaPlanners.list method.", "type": "string" }, "accountId": { "readOnly": true, "description": "Output only. Account ID of the media planner.", "type": "string", "deprecated": true }, "ancestorNames": { "description": "Output only. The ancestor names of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response of the mediaPlanners.list method.", "type": "array", "readOnly": true, "items": { "type": "string" } }, "displayName": { "description": "Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method.", "type": "string", "readOnly": true } }, "description": "Represents a media planner account.", "type": "object", "id": "MediaPlanner" }, "TaxonomyTargeting": { "properties": { "excludedTaxonomyIds": { "items": { "type": "string" }, "description": "Optional. The list of excluded content taxonomy IDs.", "type": "array" }, "targetedTaxonomyIds": { "description": "Optional. The list of targeted content taxonomy IDs.", "type": "array", "items": { "type": "string" } } }, "description": "Defines targeting criteria for handling the IAB audience and content Taxonomy ID space.", "type": "object", "id": "TaxonomyTargeting" }, "DataSegment": { "id": "DataSegment", "description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.", "type": "object", "properties": { "state": { "type": "string", "description": "Output only. The state of the data segment.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ "Default value.", "The data segment is active.", "The data segment is inactive." ] }, "createTime": { "description": "Output only. Time the data segment was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "description": "Output only. Time the data segment was last updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "cpmFee": { "description": "Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed.", "$ref": "Money" }, "name": { "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`", "type": "string" } } }, "PackagePlacementTargeting": { "properties": { "uriTargeting": { "description": "Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url.", "$ref": "StringTargetingDimension" }, "includedMobileAppCategoryTargeting": { "items": { "type": "string", "format": "int64" }, "description": "Optional. The list of targeted mobile app categories.", "type": "array" }, "mobileAppTargeting": { "description": "Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.", "$ref": "StringTargetingDimension" } }, "description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", "type": "object", "id": "PackagePlacementTargeting" }, "StringTargetingDimension": { "properties": { "selectionType": { "enumDescriptions": [ "Unspecified selection type. Should not be used.", "The values in the targeting dimension are included.", "The values in the targeting dimension are excluded." ], "enum": [ "SELECTION_TYPE_UNSPECIFIED", "SELECTION_TYPE_INCLUDE", "SELECTION_TYPE_EXCLUDE" ], "description": "Required. How the items in this list should be targeted.", "type": "string" }, "values": { "items": { "type": "string" }, "description": "Required. The values specified.", "type": "array" } }, "id": "StringTargetingDimension", "description": "Generic targeting with string values.", "type": "object" }, "ListCuratedPackagesResponse": { "properties": { "curatedPackages": { "items": { "$ref": "CuratedPackage" }, "description": "The list of curated packages.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListCuratedPackagesRequest.pageToken field in the subsequent call to `ListCuratedPackages` method to retrieve the next page of results. If empty, then there are no more results.", "type": "string" } }, "id": "ListCuratedPackagesResponse", "description": "Response message for ListCuratedPackages.", "type": "object" }, "CriteriaTargeting": { "properties": { "targetedCriteriaIds": { "items": { "type": "string", "format": "int64" }, "description": "A list of numeric IDs to be included.", "type": "array" }, "excludedCriteriaIds": { "items": { "type": "string", "format": "int64" }, "description": "A list of numeric IDs to be excluded.", "type": "array" } }, "description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax.", "type": "object", "id": "CriteriaTargeting" }, "CuratedPackage": { "id": "CuratedPackage", "description": "Represents a curated package of inventory created and managed by a Curator.", "type": "object", "properties": { "name": { "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "type": "string" }, "targeting": { "description": "Optional. Targeting criteria for the curated package.", "$ref": "PackageTargeting" }, "accessSettings": { "description": "Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource.", "$ref": "AccessControlSettings" }, "updateTime": { "readOnly": true, "description": "Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method.", "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method.", "type": "string", "format": "google-datetime", "readOnly": true }, "state": { "type": "string", "enumDescriptions": [ "Default value.", "The curated package is active.", "The curated package is inactive." ], "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "description": "Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method." }, "description": { "description": "Optional. A description of the curated package, provided by the curator.", "type": "string" }, "displayName": { "description": "Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method.", "type": "string" }, "floorPriceCpm": { "description": "Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method.", "$ref": "Money" }, "feeCpm": { "description": "Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method.", "$ref": "Money" } } }, "Money": { "description": "Represents an amount of money with its currency type.", "type": "object", "id": "Money", "properties": { "units": { "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "type": "string", "format": "int64" }, "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "type": "integer", "format": "int32" } } }, "ActivateCuratedPackageRequest": { "properties": {}, "description": "Request message for ActivateCuratedPackage.", "type": "object", "id": "ActivateCuratedPackageRequest" } }, "name": "authorizedbuyersmarketplace" }