Display & Video 360 API (displayvideo:v3)

2023-10-10

159 new methods | New API

Additions

    Methods
  • displayvideo.targetingTypes.targetingOptions.get

      Path: v3/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Gets a single targeting option.

      Parameters:

        targetingType

          Type: string

          Description: Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`

          Required: Yes

          Location: path

          Pattern: ^[^/]+$

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION

        targetingOptionId

          Required: Yes

          Type: string

          Pattern: ^[^/]+$

          Description: Required. The ID of the of targeting option to retrieve.

          Location: path

        advertiserId

          Type: string

          Description: Required. The Advertiser this request is being made in the context of.

          Location: query

          Format: int64

      Flat Path: v3/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}

      Parameter Order:

    • targetingType
    • targetingOptionId
  • displayvideo.targetingTypes.targetingOptions.search

      Parameters:

        targetingType

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Description: Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`

          Location: path

          Pattern: ^[^/]+$

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Required: Yes

          Type: string

      Description: Searches for targeting options of a given type based on the given search terms.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: targetingType

      Flat Path: v3/targetingTypes/{targetingTypesId}/targetingOptions:search

      Path: v3/targetingTypes/{+targetingType}/targetingOptions:search

      HTTP Method: POST

  • displayvideo.targetingTypes.targetingOptions.list

      Scopes: https://www.googleapis.com/auth/display-video

      Parameters:

        pageToken

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned.

          Type: string

        pageSize

          Type: integer

          Location: query

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Format: int32

        orderBy

          Location: query

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`.

        filter

          Location: query

          Type: string

          Description: Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        targetingType

          Pattern: ^[^/]+$

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Type: string

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Required: Yes

          Description: Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`

          Location: path

        advertiserId

          Location: query

          Description: Required. The Advertiser this request is being made in the context of.

          Format: int64

          Type: string

      Path: v3/targetingTypes/{+targetingType}/targetingOptions

      Description: Lists targeting options of a given type.

      Flat Path: v3/targetingTypes/{targetingTypesId}/targetingOptions

      HTTP Method: GET

      Parameter Order: targetingType

  • displayvideo.sdfdownloadtasks.create

      Flat Path: v3/sdfdownloadtasks

      Path: v3/sdfdownloadtasks

      Description: Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: POST

  • displayvideo.sdfdownloadtasks.operations.get

      Path: v3/{+name}

      Flat Path: v3/sdfdownloadtasks/operations/{operationsId}

      Description: Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/doubleclickbidmanager
    • Parameters:

        name

          Pattern: ^sdfdownloadtasks/operations/[^/]+$

          Required: Yes

          Location: path

          Description: The name of the operation resource.

          Type: string

      Parameter Order: name

      HTTP Method: GET

  • displayvideo.advertisers.create

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.

      Flat Path: v3/advertisers

      Path: v3/advertisers

  • displayvideo.advertisers.get

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: GET

      Description: Gets an advertiser.

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser to fetch.

          Format: int64

          Type: string

          Required: Yes

          Location: path

          Pattern: ^[^/]+$

      Path: v3/advertisers/{+advertiserId}

      Flat Path: v3/advertisers/{advertisersId}

      Parameter Order: advertiserId

  • displayvideo.advertisers.listAssignedTargetingOptions

      Flat Path: v3/advertisers/{advertisersId}:listAssignedTargetingOptions

      Parameters:

        pageSize

          Format: int32

          Location: query

          Type: integer

          Description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

        advertiserId

          Description: Required. The ID of the advertiser the line item belongs to.

          Location: path

          Type: string

          Pattern: ^[^/]+$

          Required: Yes

          Format: int64

        pageToken

          Type: string

          Description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

          Location: query

        orderBy

          Type: string

          Location: query

          Description: Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.

        filter

          Location: query

          Type: string

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

      Parameter Order: advertiserId

      Description: Lists assigned targeting options of an advertiser across targeting types.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: GET

      Path: v3/advertisers/{+advertiserId}:listAssignedTargetingOptions

  • displayvideo.advertisers.delete

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

      Path: v3/advertisers/{+advertiserId}

      Parameters:

        advertiserId

          Format: int64

          Required: Yes

          Description: The ID of the advertiser we need to delete.

          Pattern: ^[^/]+$

          Type: string

          Location: path

      Flat Path: v3/advertisers/{advertisersId}

      HTTP Method: DELETE

      Description: Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.

  • displayvideo.advertisers.audit

      Path: v3/advertisers/{+advertiserId}:audit

      Description: Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.

      Flat Path: v3/advertisers/{advertisersId}:audit

      Parameters:

        readMask

          Format: google-fieldmask

          Description: Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount

          Location: query

          Type: string

        advertiserId

          Pattern: ^[^/]+$

          Description: Required. The ID of the advertiser to audit.

          Location: path

          Type: string

          Format: int64

          Required: Yes

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

  • displayvideo.advertisers.patch

      Description: Updates an existing advertiser. Returns the updated advertiser if successful.

      Parameter Order: advertiserId

      Path: v3/advertisers/{+advertiserId}

      Parameters:

        advertiserId

          Location: path

          Format: int64

          Required: Yes

          Description: Output only. The unique ID of the advertiser. Assigned by the system.

          Type: string

          Pattern: ^[^/]+$

        updateMask

          Format: google-fieldmask

          Description: Required. The mask to control which fields to update.

          Location: query

          Type: string

      HTTP Method: PATCH

      Flat Path: v3/advertisers/{advertisersId}

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.editAssignedTargetingOptions

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/advertisers/{+advertiserId}:editAssignedTargetingOptions

      Parameters:

        advertiserId

          Pattern: ^[^/]+$

          Format: int64

          Location: path

          Type: string

          Required: Yes

          Description: Required. The ID of the advertiser.

      Parameter Order: advertiserId

      Description: Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .

      HTTP Method: POST

      Flat Path: v3/advertisers/{advertisersId}:editAssignedTargetingOptions

  • displayvideo.advertisers.list

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.

      HTTP Method: GET

      Parameters:

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

        pageSize

          Format: int32

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.

          Location: query

          Type: integer

        partnerId

          Location: query

          Format: int64

          Description: Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.

          Type: string

        pageToken

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned.

          Location: query

          Type: string

      Path: v3/advertisers

      Flat Path: v3/advertisers

  • displayvideo.advertisers.locationLists.patch

      Parameters:

        advertiserId

          Description: Required. The ID of the DV360 advertiser to which the location lists belongs.

          Format: int64

          Required: Yes

          Location: path

          Type: string

          Pattern: ^[^/]+$

        locationListId

          Required: Yes

          Type: string

          Format: int64

          Location: path

          Description: Output only. The unique ID of the location list. Assigned by the system.

        updateMask

          Description: Required. The mask to control which fields to update.

          Format: google-fieldmask

          Type: string

          Location: query

      Flat Path: v3/advertisers/{advertisersId}/locationLists/{locationListId}

      Path: v3/advertisers/{+advertiserId}/locationLists/{locationListId}

      Parameter Order:

    • advertiserId
    • locationListId
    • Description: Updates a location list. Returns the updated location list if successful.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: PATCH

  • displayvideo.advertisers.locationLists.get

      Path: v3/advertisers/{+advertiserId}/locationLists/{+locationListId}

      Description: Gets a location list.

      Parameter Order:

    • advertiserId
    • locationListId
    • Parameters:

        locationListId

          Pattern: ^[^/]+$

          Description: Required. The ID of the location list to fetch.

          Format: int64

          Location: path

          Required: Yes

          Type: string

        advertiserId

          Pattern: ^[^/]+$

          Required: Yes

          Format: int64

          Description: Required. The ID of the DV360 advertiser to which the fetched location list belongs.

          Type: string

          Location: path

      Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertisersId}/locationLists/{locationListsId}

      HTTP Method: GET

  • displayvideo.advertisers.locationLists.list

      Flat Path: v3/advertisers/{advertisersId}/locationLists

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/advertisers/{+advertiserId}/locationLists

      HTTP Method: GET

      Parameter Order: advertiserId

      Description: Lists location lists based on a given advertiser id.

      Parameters:

        filter

          Type: string

          Location: query

          Description: Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

          Type: string

          Location: query

        advertiserId

          Type: string

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Description: Required. The ID of the DV360 advertiser to which the fetched location lists belong.

          Format: int64

        pageToken

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned.

          Type: string

          Location: query

        pageSize

          Format: int32

          Type: integer

          Location: query

          Description: Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

  • displayvideo.advertisers.locationLists.create

      Flat Path: v3/advertisers/{advertisersId}/locationLists

      Path: v3/advertisers/{+advertiserId}/locationLists

      Description: Creates a new location list. Returns the newly created location list if successful.

      Parameters:

        advertiserId

          Format: int64

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Description: Required. The ID of the DV360 advertiser to which the location list belongs.

          Type: string

      Parameter Order: advertiserId

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.locationLists.assignedLocations.list

      Parameters:

        pageToken

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned.

          Type: string

        pageSize

          Location: query

          Format: int32

          Type: integer

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

        advertiserId

          Type: string

          Location: path

          Format: int64

          Required: Yes

          Description: Required. The ID of the DV360 advertiser to which the location list belongs.

        locationListId

          Format: int64

          Required: Yes

          Type: string

          Location: path

          Description: Required. The ID of the location list to which these assignments are assigned.

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedLocationId desc`.

          Type: string

          Location: query

        filter

          Type: string

          Description: Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

      Flat Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations

      HTTP Method: GET

      Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations

      Description: Lists locations assigned to a location list.

      Parameter Order:

    • advertiserId
    • locationListId
    • Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.locationLists.assignedLocations.bulkEdit

      Flat Path: v3/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit

      Parameters:

        locationListId

          Required: Yes

          Description: Required. The ID of the location list to which these assignments are assigned.

          Location: path

          Pattern: ^[^/]+$

          Format: int64

          Type: string

        advertiserId

          Format: int64

          Location: path

          Type: string

          Required: Yes

          Description: Required. The ID of the DV360 advertiser to which the location list belongs.

      Description: Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • advertiserId
    • locationListId
    • Path: v3/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit

      HTTP Method: POST

  • displayvideo.advertisers.locationLists.assignedLocations.create

      HTTP Method: POST

      Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations

      Description: Creates an assignment between a location and a location list.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • advertiserId
    • locationListId
    • Parameters:

        locationListId

          Description: Required. The ID of the location list for which the assignment will be created.

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

          Description: Required. The ID of the DV360 advertiser to which the location list belongs.

          Required: Yes

          Location: path

          Type: string

          Format: int64

      Flat Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations

  • displayvideo.advertisers.locationLists.assignedLocations.delete

      HTTP Method: DELETE

      Description: Deletes the assignment between a location and a location list.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • advertiserId
    • locationListId
    • assignedLocationId
    • Parameters:

        assignedLocationId

          Location: path

          Format: int64

          Pattern: ^[^/]+$

          Type: string

          Required: Yes

          Description: Required. The ID of the assigned location to delete.

        advertiserId

          Required: Yes

          Format: int64

          Type: string

          Location: path

          Description: Required. The ID of the DV360 advertiser to which the location list belongs.

        locationListId

          Required: Yes

          Location: path

          Description: Required. The ID of the location list to which this assignment is assigned.

          Format: int64

          Type: string

      Flat Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}

      Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}

  • displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list

      Description: Lists the targeting options assigned to an advertiser.

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      HTTP Method: GET

      Parameters:

        advertiserId

          Format: int64

          Required: Yes

          Type: string

          Description: Required. The ID of the advertiser.

          Location: path

          Pattern: ^[^/]+$

        orderBy

          Location: query

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.

        pageToken

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

          Location: query

          Type: string

        filter

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

        targetingType

          Pattern: ^[^/]+$

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Type: string

          Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL`

          Location: path

          Required: Yes

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.

        pageSize

          Description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Format: int32

          Location: query

          Type: integer

      Parameter Order:

    • advertiserId
    • targetingType
    • Flat Path: v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

  • displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete

      Path: v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

      Flat Path: v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

      Parameters:

        targetingType

          Required: Yes

          Pattern: ^[^/]+$

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Location: path

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Type: string

        advertiserId

          Pattern: ^[^/]+$

          Location: path

          Type: string

          Format: int64

          Required: Yes

          Description: Required. The ID of the advertiser.

        assignedTargetingOptionId

          Description: Required. The ID of the assigned targeting option to delete.

          Pattern: ^[^/]+$

          Required: Yes

          Location: path

          Type: string

      Description: Deletes an assigned targeting option from an advertiser.

      Parameter Order:

    • advertiserId
    • targetingType
    • assignedTargetingOptionId
    • Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: DELETE

  • displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create

      Path: v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      Parameter Order:

    • advertiserId
    • targetingType
    • Description: Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: POST

      Flat Path: v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

      Parameters:

        targetingType

          Pattern: ^[^/]+$

          Location: path

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Type: string

          Required: Yes

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`

        advertiserId

          Pattern: ^[^/]+$

          Type: string

          Required: Yes

          Description: Required. The ID of the advertiser.

          Format: int64

          Location: path

  • displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get

      Path: v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

      Parameter Order:

    • advertiserId
    • targetingType
    • assignedTargetingOptionId
    • Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

      Description: Gets a single targeting option assigned to an advertiser.

      Parameters:

        advertiserId

          Format: int64

          Required: Yes

          Description: Required. The ID of the advertiser.

          Pattern: ^[^/]+$

          Location: path

          Type: string

        assignedTargetingOptionId

          Pattern: ^[^/]+$

          Description: Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.

          Type: string

          Location: path

          Required: Yes

        targetingType

          Required: Yes

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL`

          Type: string

          Location: path

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Pattern: ^[^/]+$

      HTTP Method: GET

  • displayvideo.advertisers.channels.sites.delete

      Parameter Order:

    • advertiserId
    • channelId
    • urlOrAppId
    • Parameters:

        partnerId

          Format: int64

          Description: The ID of the partner that owns the parent channel.

          Type: string

          Location: query

        advertiserId

          Type: string

          Format: int64

          Description: The ID of the advertiser that owns the parent channel.

          Required: Yes

          Location: path

        urlOrAppId

          Type: string

          Location: path

          Required: Yes

          Description: Required. The URL or app ID of the site to delete.

          Pattern: ^[^/]+$

        channelId

          Description: Required. The ID of the parent channel to which the site belongs.

          Format: int64

          Location: path

          Type: string

          Required: Yes

          Pattern: ^[^/]+$

      Path: v3/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}

      Flat Path: v3/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Deletes a site from a channel.

  • displayvideo.advertisers.channels.sites.replace

      Path: v3/advertisers/{advertiserId}/channels/{+channelId}/sites:replace

      Description: Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.

      Parameters:

        channelId

          Description: Required. The ID of the parent channel whose sites will be replaced.

          Type: string

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the parent channel.

          Format: int64

          Type: string

          Required: Yes

          Location: path

      Flat Path: v3/advertisers/{advertiserId}/channels/{channelsId}/sites:replace

      HTTP Method: POST

      Parameter Order:

    • advertiserId
    • channelId
    • Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.channels.sites.list

      Parameter Order:

    • advertiserId
    • channelId
    • Path: v3/advertisers/{+advertiserId}/channels/{+channelId}/sites

      Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertisersId}/channels/{channelsId}/sites

      HTTP Method: GET

      Parameters:

        partnerId

          Type: string

          Format: int64

          Description: The ID of the partner that owns the parent channel.

          Location: query

        advertiserId

          Required: Yes

          Pattern: ^[^/]+$

          Type: string

          Location: path

          Format: int64

          Description: The ID of the advertiser that owns the parent channel.

        filter

          Description: Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

        orderBy

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.

          Location: query

        channelId

          Description: Required. The ID of the parent channel to which the requested sites belong.

          Pattern: ^[^/]+$

          Type: string

          Location: path

          Required: Yes

          Format: int64

        pageSize

          Format: int32

          Type: integer

          Description: Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Location: query

        pageToken

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.

          Type: string

          Location: query

      Description: Lists sites in a channel.

  • displayvideo.advertisers.channels.sites.create

      Parameter Order:

    • advertiserId
    • channelId
    • Description: Creates a site in a channel.

      Parameters:

        advertiserId

          Required: Yes

          Description: The ID of the advertiser that owns the parent channel.

          Type: string

          Location: path

          Format: int64

        channelId

          Type: string

          Location: path

          Required: Yes

          Format: int64

          Pattern: ^[^/]+$

          Description: Required. The ID of the parent channel in which the site will be created.

        partnerId

          Type: string

          Description: The ID of the partner that owns the parent channel.

          Format: int64

          Location: query

      Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertiserId}/channels/{channelsId}/sites

      Path: v3/advertisers/{advertiserId}/channels/{+channelId}/sites

      HTTP Method: POST

  • displayvideo.advertisers.channels.sites.bulkEdit

      HTTP Method: POST

      Parameter Order:

    • advertiserId
    • channelId
    • Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit

      Parameters:

        channelId

          Location: path

          Type: string

          Required: Yes

          Pattern: ^[^/]+$

          Format: int64

          Description: Required. The ID of the parent channel to which the sites belong.

        advertiserId

          Format: int64

          Description: The ID of the advertiser that owns the parent channel.

          Type: string

          Required: Yes

          Location: path

      Path: v3/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit

      Description: Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

  • displayvideo.advertisers.channels.list

      Parameter Order: advertiserId

      Path: v3/advertisers/{+advertiserId}/channels

      Description: Lists channels for a partner or advertiser.

      Flat Path: v3/advertisers/{advertisersId}/channels

      Parameters:

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`.

          Location: query

          Type: string

        pageToken

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.

          Location: query

          Type: string

        pageSize

          Location: query

          Format: int32

          Type: integer

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

        partnerId

          Type: string

          Location: query

          Description: The ID of the partner that owns the channels.

          Format: int64

        filter

          Description: Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Type: string

          Location: query

        advertiserId

          Description: The ID of the advertiser that owns the channels.

          Pattern: ^[^/]+$

          Location: path

          Type: string

          Required: Yes

          Format: int64

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.channels.get

      Parameters:

        advertiserId

          Location: path

          Required: Yes

          Description: The ID of the advertiser that owns the fetched channel.

          Type: string

          Format: int64

          Pattern: ^[^/]+$

        channelId

          Description: Required. The ID of the channel to fetch.

          Location: path

          Format: int64

          Required: Yes

          Pattern: ^[^/]+$

          Type: string

        partnerId

          Location: query

          Format: int64

          Description: The ID of the partner that owns the fetched channel.

          Type: string

      HTTP Method: GET

      Description: Gets a channel for a partner or advertiser.

      Flat Path: v3/advertisers/{advertisersId}/channels/{channelsId}

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/advertisers/{+advertiserId}/channels/{+channelId}

      Parameter Order:

    • advertiserId
    • channelId
  • displayvideo.advertisers.channels.patch

      Parameters:

        updateMask

          Description: Required. The mask to control which fields to update.

          Location: query

          Format: google-fieldmask

          Type: string

        partnerId

          Format: int64

          Description: The ID of the partner that owns the created channel.

          Location: query

          Type: string

        channelId

          Format: int64

          Description: Output only. The unique ID of the channel. Assigned by the system.

          Required: Yes

          Type: string

          Location: path

        advertiserId

          Pattern: ^[^/]+$

          Required: Yes

          Location: path

          Description: The ID of the advertiser that owns the created channel.

          Type: string

          Format: int64

      Path: v3/advertisers/{+advertiserId}/channels/{channelId}

      Parameter Order:

    • advertiserId
    • channelId
    • Description: Updates a channel. Returns the updated channel if successful.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: PATCH

      Flat Path: v3/advertisers/{advertisersId}/channels/{channelId}

  • displayvideo.advertisers.channels.create

      Description: Creates a new channel. Returns the newly created channel if successful.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

      HTTP Method: POST

      Path: v3/advertisers/{+advertiserId}/channels

      Parameters:

        advertiserId

          Required: Yes

          Location: path

          Format: int64

          Description: The ID of the advertiser that owns the created channel.

          Type: string

          Pattern: ^[^/]+$

        partnerId

          Format: int64

          Type: string

          Description: The ID of the partner that owns the created channel.

          Location: query

      Flat Path: v3/advertisers/{advertisersId}/channels

  • displayvideo.advertisers.invoices.list

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Flat Path: v3/advertisers/{advertisersId}/invoices

      Parameters:

        pageSize

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Format: int32

          Location: query

          Type: integer

        loiSapinInvoiceType

          Type: string

          Enum:

        • LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED
        • LOI_SAPIN_INVOICE_TYPE_MEDIA
        • LOI_SAPIN_INVOICE_TYPE_PLATFORM
        • Enum Descriptions:

        • Value is not specified.
        • Invoices with Media cost.
        • Invoices with Platform fee.
        • Description: Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.

          Location: query

        advertiserId

          Location: path

          Pattern: ^[^/]+$

          Format: int64

          Description: Required. The ID of the advertiser to list invoices for.

          Required: Yes

          Type: string

        issueMonth

          Type: string

          Location: query

          Description: The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.

        pageToken

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned.

          Type: string

      Path: v3/advertisers/{+advertiserId}/invoices

      HTTP Method: GET

      Parameter Order: advertiserId

      Description: Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.

  • displayvideo.advertisers.invoices.lookupInvoiceCurrency

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser to lookup currency for.

          Location: path

          Pattern: ^[^/]+$

          Format: int64

          Type: string

          Required: Yes

        invoiceMonth

          Description: Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.

          Location: query

          Type: string

      Path: v3/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency

      Description: Retrieves the invoice currency used by an advertiser in a given month.

      Flat Path: v3/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency

      Parameter Order: advertiserId

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
  • displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

        orderBy

          Location: query

          Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.

          Type: string

        filter

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

        pageSize

          Location: query

          Type: integer

          Format: int32

          Description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

        campaignId

          Description: Required. The ID of the campaign to list assigned targeting options for.

          Pattern: ^[^/]+$

          Required: Yes

          Location: path

          Format: int64

          Type: string

        targetingType

          Pattern: ^[^/]+$

          Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY`

          Location: path

          Type: string

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Required: Yes

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION

        advertiserId

          Format: int64

          Type: string

          Required: Yes

          Description: Required. The ID of the advertiser the campaign belongs to.

          Pattern: ^[^/]+$

          Location: path

      Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      HTTP Method: GET

      Description: Lists the targeting options assigned to a campaign for a specified targeting type.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • advertiserId
    • campaignId
    • targetingType
    • Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

  • displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get

      Parameters:

        campaignId

          Required: Yes

          Format: int64

          Location: path

          Type: string

          Pattern: ^[^/]+$

          Description: Required. The ID of the campaign the assigned targeting option belongs to.

        assignedTargetingOptionId

          Pattern: ^[^/]+$

          Description: Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested.

          Type: string

          Location: path

          Required: Yes

        targetingType

          Required: Yes

          Type: string

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY`

          Pattern: ^[^/]+$

          Location: path

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.

        advertiserId

          Type: string

          Required: Yes

          Description: Required. The ID of the advertiser the campaign belongs to.

          Location: path

          Format: int64

          Pattern: ^[^/]+$

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Gets a single targeting option assigned to a campaign.

      Parameter Order:

    • advertiserId
    • campaignId
    • targetingType
    • assignedTargetingOptionId
    • Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

      HTTP Method: GET

      Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

  • displayvideo.advertisers.campaigns.create

      HTTP Method: POST

      Path: v3/advertisers/{+advertiserId}/campaigns

      Parameters:

        advertiserId

          Description: Output only. The unique ID of the advertiser the campaign belongs to.

          Required: Yes

          Location: path

          Pattern: ^[^/]+$

          Type: string

          Format: int64

      Parameter Order: advertiserId

      Flat Path: v3/advertisers/{advertisersId}/campaigns

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Description: Creates a new campaign. Returns the newly created campaign if successful.

  • displayvideo.advertisers.campaigns.patch

      Description: Updates an existing campaign. Returns the updated campaign if successful.

      Parameters:

        campaignId

          Location: path

          Type: string

          Description: Output only. The unique ID of the campaign. Assigned by the system.

          Pattern: ^[^/]+$

          Required: Yes

          Format: int64

        advertiserId

          Description: Output only. The unique ID of the advertiser the campaign belongs to.

          Location: path

          Format: int64

          Pattern: ^[^/]+$

          Required: Yes

          Type: string

        updateMask

          Type: string

          Location: query

          Format: google-fieldmask

          Description: Required. The mask to control which fields to update.

      Parameter Order:

    • advertiserId
    • campaignId
    • Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}

      Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}

      HTTP Method: PATCH

  • displayvideo.advertisers.campaigns.listAssignedTargetingOptions

      Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}:listAssignedTargetingOptions

      Parameter Order:

    • advertiserId
    • campaignId
    • Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions

      HTTP Method: GET

      Parameters:

        filter

          Type: string

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

        pageToken

          Type: string

          Location: query

          Description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

        pageSize

          Type: integer

          Description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Format: int32

          Location: query

        campaignId

          Location: path

          Required: Yes

          Format: int64

          Pattern: ^[^/]+$

          Type: string

          Description: Required. The ID of the campaign to list assigned targeting options for.

        orderBy

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.

          Location: query

        advertiserId

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Format: int64

          Description: Required. The ID of the advertiser the campaign belongs to.

          Type: string

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Lists assigned targeting options of a campaign across targeting types.

  • displayvideo.advertisers.campaigns.delete

      Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}

      Description: Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}

      Parameters:

        advertiserId

          Format: int64

          Description: The ID of the advertiser this campaign belongs to.

          Type: string

          Pattern: ^[^/]+$

          Required: Yes

          Location: path

        campaignId

          Location: path

          Format: int64

          Description: The ID of the campaign we need to delete.

          Required: Yes

          Pattern: ^[^/]+$

          Type: string

      HTTP Method: DELETE

      Parameter Order:

    • advertiserId
    • campaignId
  • displayvideo.advertisers.campaigns.get

      Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}

      Description: Gets a campaign.

      Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}

      Parameter Order:

    • advertiserId
    • campaignId
    • Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Parameters:

        campaignId

          Pattern: ^[^/]+$

          Required: Yes

          Description: Required. The ID of the campaign to fetch.

          Format: int64

          Location: path

          Type: string

        advertiserId

          Format: int64

          Description: Required. The ID of the advertiser this campaign belongs to.

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Type: string

      HTTP Method: GET

  • displayvideo.advertisers.campaigns.list

      Path: v3/advertisers/{+advertiserId}/campaigns

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Parameter Order: advertiserId

      Flat Path: v3/advertisers/{advertisersId}/campaigns

      Parameters:

        filter

          Type: string

          Location: query

          Description: Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        pageSize

          Type: integer

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.

          Location: query

          Format: int32

        pageToken

          Type: string

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.

          Location: query

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

          Location: query

          Type: string

        advertiserId

          Pattern: ^[^/]+$

          Format: int64

          Description: The ID of the advertiser to list campaigns for.

          Type: string

          Location: path

          Required: Yes

      HTTP Method: GET

      Description: Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

  • displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get

      Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Gets a single targeting option assigned to a line item.

      Parameter Order:

    • advertiserId
    • lineItemId
    • targetingType
    • assignedTargetingOptionId
    • Parameters:

        targetingType

          Pattern: ^[^/]+$

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Location: path

          Type: string

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)

          Required: Yes

        lineItemId

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Format: int64

          Type: string

          Description: Required. The ID of the line item the assigned targeting option belongs to.

        assignedTargetingOptionId

          Description: Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

        advertiserId

          Description: Required. The ID of the advertiser the line item belongs to.

          Format: int64

          Type: string

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

      HTTP Method: GET

      Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

  • displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      Parameters:

        advertiserId

          Location: path

          Format: int64

          Type: string

          Description: Required. The ID of the advertiser the line item belongs to.

          Required: Yes

          Pattern: ^[^/]+$

        targetingType

          Required: Yes

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`

          Location: path

          Type: string

          Pattern: ^[^/]+$

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.

        lineItemId

          Pattern: ^[^/]+$

          Format: int64

          Required: Yes

          Location: path

          Description: Required. The ID of the line item the assigned targeting option will belong to.

          Type: string

      HTTP Method: POST

      Parameter Order:

    • advertiserId
    • lineItemId
    • targetingType
    • Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

      Description: Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption

  • displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list

      HTTP Method: GET

      Parameters:

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.

          Location: query

          Type: string

        lineItemId

          Type: string

          Pattern: ^[^/]+$

          Format: int64

          Location: path

          Description: Required. The ID of the line item to list assigned targeting options for.

          Required: Yes

        filter

          Type: string

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

        targetingType

          Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)

          Location: path

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Pattern: ^[^/]+$

          Type: string

          Required: Yes

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.

        pageToken

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

          Type: string

          Location: query

        pageSize

          Format: int32

          Type: integer

          Description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Location: query

        advertiserId

          Format: int64

          Pattern: ^[^/]+$

          Type: string

          Required: Yes

          Description: Required. The ID of the advertiser the line item belongs to.

          Location: path

      Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

      Description: Lists the targeting options assigned to a line item.

      Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      Parameter Order:

    • advertiserId
    • lineItemId
    • targetingType
  • displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete

      HTTP Method: DELETE

      Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

      Description: Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption

      Scopes: https://www.googleapis.com/auth/display-video

      Parameters:

        lineItemId

          Format: int64

          Required: Yes

          Description: Required. The ID of the line item the assigned targeting option belongs to.

          Type: string

          Pattern: ^[^/]+$

          Location: path

        advertiserId

          Type: string

          Location: path

          Description: Required. The ID of the advertiser the line item belongs to.

          Required: Yes

          Pattern: ^[^/]+$

          Format: int64

        assignedTargetingOptionId

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Description: Required. The ID of the assigned targeting option to delete.

          Type: string

        targetingType

          Pattern: ^[^/]+$

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`

          Required: Yes

          Type: string

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Location: path

      Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

      Parameter Order:

    • advertiserId
    • lineItemId
    • targetingType
    • assignedTargetingOptionId
  • displayvideo.advertisers.lineItems.delete

      HTTP Method: DELETE

      Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • advertiserId
    • lineItemId
    • Description: Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.

      Parameters:

        lineItemId

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Type: string

          Format: int64

          Description: The ID of the line item to delete.

        advertiserId

          Pattern: ^[^/]+$

          Format: int64

          Type: string

          Description: The ID of the advertiser this line item belongs to.

          Location: path

          Required: Yes

      Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}

  • displayvideo.advertisers.lineItems.patch

      Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}

      Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}

      Parameter Order:

    • advertiserId
    • lineItemId
    • Parameters:

        updateMask

          Type: string

          Format: google-fieldmask

          Description: Required. The mask to control which fields to update.

          Location: query

        lineItemId

          Required: Yes

          Format: int64

          Type: string

          Description: Output only. The unique ID of the line item. Assigned by the system.

          Pattern: ^[^/]+$

          Location: path

        advertiserId

          Location: path

          Format: int64

          Type: string

          Pattern: ^[^/]+$

          Required: Yes

          Description: Output only. The unique ID of the advertiser the line item belongs to.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: PATCH

      Description: Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete

  • displayvideo.advertisers.lineItems.get

      Parameter Order:

    • advertiserId
    • lineItemId
    • HTTP Method: GET

      Parameters:

        lineItemId

          Pattern: ^[^/]+$

          Format: int64

          Description: Required. The ID of the line item to fetch.

          Location: path

          Type: string

          Required: Yes

        advertiserId

          Pattern: ^[^/]+$

          Format: int64

          Required: Yes

          Type: string

          Description: Required. The ID of the advertiser this line item belongs to.

          Location: path

      Description: Gets a line item.

      Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}

      Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions

      Description: Lists assigned targeting options for multiple line items across targeting types.

      HTTP Method: GET

      Flat Path: v3/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions

      Path: v3/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions

      Scopes: https://www.googleapis.com/auth/display-video

      Parameters:

        lineItemIds

          Type: string

          Description: Required. The IDs of the line items to list assigned targeting options for.

          Location: query

          Repeated: Yes

          Format: int64

        pageToken

          Location: query

          Type: string

          Description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

        pageSize

          Format: int32

          Location: query

          Type: integer

          Description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

        filter

          Location: query

          Type: string

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        advertiserId

          Type: string

          Format: int64

          Pattern: ^[^/]+$

          Required: Yes

          Description: Required. The ID of the advertiser the line items belongs to.

          Location: path

        orderBy

          Location: query

          Description: Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.

          Type: string

      Parameter Order: advertiserId

  • displayvideo.advertisers.lineItems.create

      Parameters:

        advertiserId

          Location: path

          Required: Yes

          Description: Output only. The unique ID of the advertiser the line item belongs to.

          Pattern: ^[^/]+$

          Type: string

          Format: int64

      Description: Creates a new line item. Returns the newly created line item if successful.

      HTTP Method: POST

      Flat Path: v3/advertisers/{advertisersId}/lineItems

      Parameter Order: advertiserId

      Path: v3/advertisers/{+advertiserId}/lineItems

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions

      HTTP Method: POST

      Description: Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete

      Flat Path: v3/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

      Parameters:

        advertiserId

          Required: Yes

          Location: path

          Pattern: ^[^/]+$

          Format: int64

          Description: Required. The ID of the advertiser the line items belong to.

          Type: string

      Path: v3/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions

  • displayvideo.advertisers.lineItems.list

      Path: v3/advertisers/{+advertiserId}/lineItems

      Parameters:

        filter

          Location: query

          Description: Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Type: string

        pageToken

          Type: string

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned.

        advertiserId

          Type: string

          Required: Yes

          Pattern: ^[^/]+$

          Description: Required. The ID of the advertiser to list line items for.

          Location: path

          Format: int64

        orderBy

          Type: string

          Location: query

          Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

        pageSize

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Type: integer

          Format: int32

          Location: query

      Description: Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

      Flat Path: v3/advertisers/{advertisersId}/lineItems

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

      HTTP Method: GET

  • displayvideo.advertisers.lineItems.bulkUpdate

      Description: Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete

      Parameter Order: advertiserId

      Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertisersId}/lineItems:bulkUpdate

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser this line item belongs to.

          Type: string

          Pattern: ^[^/]+$

          Location: path

          Format: int64

          Required: Yes

      HTTP Method: POST

      Path: v3/advertisers/{+advertiserId}/lineItems:bulkUpdate

  • displayvideo.advertisers.lineItems.duplicate

      Parameters:

        advertiserId

          Type: string

          Required: Yes

          Format: int64

          Pattern: ^[^/]+$

          Description: Required. The ID of the advertiser this line item belongs to.

          Location: path

        lineItemId

          Pattern: ^[^/]+$

          Type: string

          Required: Yes

          Description: Required. The ID of the line item to duplicate.

          Location: path

          Format: int64

      Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate

      Parameter Order:

    • advertiserId
    • lineItemId
    • Description: Duplicates a line item. Returns the ID of the created line item if successful.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: POST

      Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate

  • displayvideo.advertisers.lineItems.generateDefault

      Path: v3/advertisers/{+advertiserId}/lineItems:generateDefault

      HTTP Method: POST

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser this line item belongs to.

          Location: path

          Format: int64

          Type: string

          Required: Yes

          Pattern: ^[^/]+$

      Description: Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

      Flat Path: v3/advertisers/{advertisersId}/lineItems:generateDefault

  • displayvideo.advertisers.assets.upload

      Path: v3/advertisers/{+advertiserId}/assets

      Parameter Order: advertiserId

      Flat Path: v3/advertisers/{advertisersId}/assets

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).

      Mediaupload:

        Accept: */*

        Protocols:

          Simple:

            Path: /upload/v3/advertisers/{+advertiserId}/assets

            Multipart: Yes

      Parameters:

        advertiserId

          Type: string

          Description: Required. The ID of the advertiser this asset belongs to.

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Format: int64

      HTTP Method: POST

      Supportsmediaupload: Yes

  • displayvideo.advertisers.insertionOrders.create

      Description: Creates a new insertion order. Returns the newly created insertion order if successful.

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders

      Parameters:

        advertiserId

          Required: Yes

          Type: string

          Pattern: ^[^/]+$

          Description: Output only. The unique ID of the advertiser the insertion order belongs to.

          Location: path

          Format: int64

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

      Path: v3/advertisers/{+advertiserId}/insertionOrders

  • displayvideo.advertisers.insertionOrders.get

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}

      Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}

      Parameter Order:

    • advertiserId
    • insertionOrderId
    • Description: Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.

      HTTP Method: GET

      Parameters:

        advertiserId

          Pattern: ^[^/]+$

          Required: Yes

          Type: string

          Format: int64

          Description: Required. The ID of the advertiser this insertion order belongs to.

          Location: path

        insertionOrderId

          Format: int64

          Description: Required. The ID of the insertion order to fetch.

          Required: Yes

          Type: string

          Location: path

          Pattern: ^[^/]+$

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.insertionOrders.delete

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}

      Description: Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.

      Parameters:

        insertionOrderId

          Pattern: ^[^/]+$

          Description: The ID of the insertion order to delete.

          Location: path

          Format: int64

          Required: Yes

          Type: string

        advertiserId

          Description: The ID of the advertiser this insertion order belongs to.

          Type: string

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Format: int64

      HTTP Method: DELETE

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}

      Parameter Order:

    • advertiserId
    • insertionOrderId
  • displayvideo.advertisers.insertionOrders.list

      Parameters:

        orderBy

          Location: query

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

        pageSize

          Format: int32

          Description: Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Type: integer

          Location: query

        pageToken

          Type: string

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned.

          Location: query

        advertiserId

          Required: Yes

          Format: int64

          Location: path

          Pattern: ^[^/]+$

          Description: Required. The ID of the advertiser to list insertion orders for.

          Type: string

        filter

          Type: string

          Description: Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: GET

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders

      Description: Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

      Path: v3/advertisers/{+advertiserId}/insertionOrders

      Parameter Order: advertiserId

  • displayvideo.advertisers.insertionOrders.patch

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}

      Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}

      Parameters:

        updateMask

          Format: google-fieldmask

          Type: string

          Description: Required. The mask to control which fields to update.

          Location: query

        advertiserId

          Description: Output only. The unique ID of the advertiser the insertion order belongs to.

          Location: path

          Format: int64

          Type: string

          Required: Yes

          Pattern: ^[^/]+$

        insertionOrderId

          Type: string

          Pattern: ^[^/]+$

          Format: int64

          Description: Output only. The unique ID of the insertion order. Assigned by the system.

          Location: path

          Required: Yes

      Description: Updates an existing insertion order. Returns the updated insertion order if successful.

      Parameter Order:

    • advertiserId
    • insertionOrderId
    • HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.insertionOrders.listAssignedTargetingOptions

      Parameter Order:

    • advertiserId
    • insertionOrderId
    • Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions

      HTTP Method: GET

      Description: Lists assigned targeting options of an insertion order across targeting types.

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}:listAssignedTargetingOptions

      Scopes: https://www.googleapis.com/auth/display-video

      Parameters:

        filter

          Type: string

          Location: query

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        advertiserId

          Format: int64

          Type: string

          Description: Required. The ID of the advertiser the insertion order belongs to.

          Required: Yes

          Location: path

          Pattern: ^[^/]+$

        pageToken

          Description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

          Type: string

          Location: query

        pageSize

          Type: integer

          Description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Location: query

          Format: int32

        orderBy

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.

          Location: query

        insertionOrderId

          Type: string

          Format: int64

          Pattern: ^[^/]+$

          Description: Required. The ID of the insertion order to list assigned targeting options for.

          Location: path

          Required: Yes

  • displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list

      Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      Description: Lists the targeting options assigned to an insertion order.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • advertiserId
    • insertionOrderId
    • targetingType
    • HTTP Method: GET

      Parameters:

        pageToken

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

          Location: query

          Type: string

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.

          Location: query

          Type: string

        insertionOrderId

          Description: Required. The ID of the insertion order to list assigned targeting options for.

          Location: path

          Pattern: ^[^/]+$

          Type: string

          Format: int64

          Required: Yes

        filter

          Location: query

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Type: string

        advertiserId

          Format: int64

          Pattern: ^[^/]+$

          Required: Yes

          Description: Required. The ID of the advertiser the insertion order belongs to.

          Location: path

          Type: string

        pageSize

          Description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Type: integer

          Format: int32

          Location: query

        targetingType

          Type: string

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

  • displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.create

      Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      Parameter Order:

    • advertiserId
    • insertionOrderId
    • targetingType
    • Parameters:

        insertionOrderId

          Location: path

          Format: int64

          Required: Yes

          Type: string

          Pattern: ^[^/]+$

          Description: Required. The ID of the insertion order the assigned targeting option will belong to.

        advertiserId

          Required: Yes

          Description: Required. The ID of the advertiser the insertion order belongs to.

          Type: string

          Pattern: ^[^/]+$

          Location: path

          Format: int64

        targetingType

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`

          Type: string

          Location: path

          Required: Yes

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Pattern: ^[^/]+$

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.

      Description: Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`

      HTTP Method: POST

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get

      Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

      Parameter Order:

    • advertiserId
    • insertionOrderId
    • targetingType
    • assignedTargetingOptionId
    • Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

      HTTP Method: GET

      Parameters:

        insertionOrderId

          Description: Required. The ID of the insertion order the assigned targeting option belongs to.

          Location: path

          Pattern: ^[^/]+$

          Type: string

          Required: Yes

          Format: int64

        targetingType

          Required: Yes

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`

          Location: path

          Type: string

          Pattern: ^[^/]+$

        advertiserId

          Format: int64

          Location: path

          Type: string

          Required: Yes

          Pattern: ^[^/]+$

          Description: Required. The ID of the advertiser the insertion order belongs to.

        assignedTargetingOptionId

          Pattern: ^[^/]+$

          Type: string

          Location: path

          Description: Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested.

          Required: Yes

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Gets a single targeting option assigned to an insertion order.

  • displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.delete

      Parameters:

        insertionOrderId

          Pattern: ^[^/]+$

          Description: Required. The ID of the insertion order the assigned targeting option belongs to.

          Type: string

          Format: int64

          Required: Yes

          Location: path

        assignedTargetingOptionId

          Required: Yes

          Description: Required. The ID of the assigned targeting option to delete.

          Pattern: ^[^/]+$

          Type: string

          Location: path

        advertiserId

          Format: int64

          Required: Yes

          Description: Required. The ID of the advertiser the insertion order belongs to.

          Pattern: ^[^/]+$

          Type: string

          Location: path

        targetingType

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Pattern: ^[^/]+$

          Location: path

          Type: string

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Required: Yes

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`

      Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

      Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

      Parameter Order:

    • advertiserId
    • insertionOrderId
    • targetingType
    • assignedTargetingOptionId
    • Description: Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.creatives.get

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • advertiserId
    • creativeId
    • HTTP Method: GET

      Flat Path: v3/advertisers/{advertisersId}/creatives/{creativesId}

      Parameters:

        creativeId

          Pattern: ^[^/]+$

          Location: path

          Format: int64

          Required: Yes

          Type: string

          Description: Required. The ID of the creative to fetch.

        advertiserId

          Pattern: ^[^/]+$

          Format: int64

          Description: Required. The ID of the advertiser this creative belongs to.

          Required: Yes

          Location: path

          Type: string

      Description: Gets a creative.

      Path: v3/advertisers/{+advertiserId}/creatives/{+creativeId}

  • displayvideo.advertisers.creatives.create

      Path: v3/advertisers/{+advertiserId}/creatives

      Parameter Order: advertiserId

      HTTP Method: POST

      Flat Path: v3/advertisers/{advertisersId}/creatives

      Parameters:

        advertiserId

          Pattern: ^[^/]+$

          Required: Yes

          Description: Output only. The unique ID of the advertiser the creative belongs to.

          Format: int64

          Type: string

          Location: path

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Creates a new creative. Returns the newly created creative if successful.

  • displayvideo.advertisers.creatives.delete

      Parameter Order:

    • advertiserId
    • creativeId
    • Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertisersId}/creatives/{creativesId}

      Description: Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted.

      Parameters:

        advertiserId

          Description: The ID of the advertiser this creative belongs to.

          Format: int64

          Pattern: ^[^/]+$

          Required: Yes

          Type: string

          Location: path

        creativeId

          Description: The ID of the creative to be deleted.

          Location: path

          Pattern: ^[^/]+$

          Required: Yes

          Type: string

          Format: int64

      HTTP Method: DELETE

      Path: v3/advertisers/{+advertiserId}/creatives/{+creativeId}

  • displayvideo.advertisers.creatives.list

      Flat Path: v3/advertisers/{advertisersId}/creatives

      Parameters:

        advertiserId

          Pattern: ^[^/]+$

          Type: string

          Description: Required. The ID of the advertiser to list creatives for.

          Location: path

          Required: Yes

          Format: int64

        orderBy

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`.

          Location: query

        filter

          Location: query

          Description: Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Type: string

        pageToken

          Location: query

          Type: string

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned.

        pageSize

          Type: integer

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Location: query

          Format: int32

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

      Path: v3/advertisers/{+advertiserId}/creatives

      Description: Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.

  • displayvideo.advertisers.creatives.patch

      Description: Updates an existing creative. Returns the updated creative if successful.

      Parameter Order:

    • advertiserId
    • creativeId
    • Path: v3/advertisers/{+advertiserId}/creatives/{+creativeId}

      Parameters:

        advertiserId

          Location: path

          Format: int64

          Pattern: ^[^/]+$

          Type: string

          Description: Output only. The unique ID of the advertiser the creative belongs to.

          Required: Yes

        creativeId

          Format: int64

          Location: path

          Required: Yes

          Pattern: ^[^/]+$

          Type: string

          Description: Output only. The unique ID of the creative. Assigned by the system.

        updateMask

          Description: Required. The mask to control which fields to update.

          Format: google-fieldmask

          Location: query

          Type: string

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: PATCH

      Flat Path: v3/advertisers/{advertisersId}/creatives/{creativesId}

  • displayvideo.advertisers.adGroupAds.list

      Parameter Order: advertiserId

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Lists ad group ads.

      Flat Path: v3/advertisers/{advertisersId}/adGroupAds

      HTTP Method: GET

      Path: v3/advertisers/{+advertiserId}/adGroupAds

      Parameters:

        advertiserId

          Required: Yes

          Location: path

          Type: string

          Format: int64

          Description: Required. The ID of the advertiser the ad groups belongs to.

          Pattern: ^[^/]+$

        orderBy

          Description: Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

          Location: query

          Type: string

        pageToken

          Description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned.

          Type: string

          Location: query

        filter

          Type: string

          Location: query

          Description: Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        pageSize

          Type: integer

          Location: query

          Description: Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Format: int32

  • displayvideo.advertisers.adGroupAds.get

      HTTP Method: GET

      Parameter Order:

    • advertiserId
    • adGroupAdId
    • Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}

      Flat Path: v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}

      Description: Gets an ad group ad.

      Parameters:

        adGroupAdId

          Pattern: ^[^/]+$

          Type: string

          Description: Required. The ID of the ad group ad to fetch.

          Required: Yes

          Format: int64

          Location: path

        advertiserId

          Required: Yes

          Format: int64

          Type: string

          Pattern: ^[^/]+$

          Location: path

          Description: Required. The ID of the advertiser this ad group ad belongs to.

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create

      Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords

      HTTP Method: POST

      Parameters:

        negativeKeywordListId

          Format: int64

          Location: path

          Required: Yes

          Type: string

          Pattern: ^[^/]+$

          Description: Required. The ID of the parent negative keyword list in which the negative keyword will be created.

        advertiserId

          Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

          Location: path

          Required: Yes

          Format: int64

          Type: string

      Parameter Order:

    • advertiserId
    • negativeKeywordListId
    • Scopes: https://www.googleapis.com/auth/display-video

      Description: Creates a negative keyword in a negative keyword list.

      Flat Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit

      HTTP Method: POST

      Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit

      Description: Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.

      Flat Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit

      Parameter Order:

    • advertiserId
    • negativeKeywordListId
    • Parameters:

        advertiserId

          Required: Yes

          Location: path

          Format: int64

          Type: string

          Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

        negativeKeywordListId

          Format: int64

          Required: Yes

          Location: path

          Description: Required. The ID of the parent negative keyword list to which the negative keywords belong.

          Pattern: ^[^/]+$

          Type: string

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list

      Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Lists negative keywords in a negative keyword list.

      Parameter Order:

    • advertiserId
    • negativeKeywordListId
    • Parameters:

        filter

          Type: string

          Location: query

          Description: Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        pageToken

          Location: query

          Type: string

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned.

        pageSize

          Format: int32

          Description: Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Location: query

          Type: integer

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`.

          Location: query

          Type: string

        advertiserId

          Format: int64

          Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

          Location: path

          Type: string

          Pattern: ^[^/]+$

          Required: Yes

        negativeKeywordListId

          Required: Yes

          Pattern: ^[^/]+$

          Description: Required. The ID of the parent negative keyword list to which the requested negative keywords belong.

          Format: int64

          Type: string

          Location: path

      Path: v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords

      HTTP Method: GET

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete

      Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}

      Description: Deletes a negative keyword from a negative keyword list.

      Flat Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}

      Parameter Order:

    • advertiserId
    • negativeKeywordListId
    • keywordValue
    • Parameters:

        keywordValue

          Required: Yes

          Description: Required. The keyword value of the negative keyword to delete.

          Location: path

          Type: string

          Pattern: ^[^/]+$

        advertiserId

          Location: path

          Format: int64

          Type: string

          Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

          Required: Yes

        negativeKeywordListId

          Required: Yes

          Format: int64

          Pattern: ^[^/]+$

          Description: Required. The ID of the parent negative keyword list to which the negative keyword belongs.

          Location: path

          Type: string

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace

      HTTP Method: POST

      Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace

      Scopes: https://www.googleapis.com/auth/display-video

      Parameters:

        negativeKeywordListId

          Location: path

          Type: string

          Required: Yes

          Format: int64

          Description: Required. The ID of the parent negative keyword list to which the negative keywords belong.

          Pattern: ^[^/]+$

        advertiserId

          Type: string

          Required: Yes

          Format: int64

          Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

          Location: path

      Description: Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

      Parameter Order:

    • advertiserId
    • negativeKeywordListId
    • Flat Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace

  • displayvideo.advertisers.negativeKeywordLists.create

      Parameters:

        advertiserId

          Pattern: ^[^/]+$

          Format: int64

          Location: path

          Description: Required. The ID of the DV360 advertiser to which the negative keyword list will belong.

          Type: string

          Required: Yes

      Path: v3/advertisers/{+advertiserId}/negativeKeywordLists

      Parameter Order: advertiserId

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: POST

      Description: Creates a new negative keyword list. Returns the newly created negative keyword list if successful.

      Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists

  • displayvideo.advertisers.negativeKeywordLists.get

      Parameters:

        advertiserId

          Description: Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.

          Type: string

          Location: path

          Pattern: ^[^/]+$

          Format: int64

          Required: Yes

        negativeKeywordListId

          Type: string

          Format: int64

          Required: Yes

          Description: Required. The ID of the negative keyword list to fetch.

          Location: path

          Pattern: ^[^/]+$

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: GET

      Path: v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}

      Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}

      Parameter Order:

    • advertiserId
    • negativeKeywordListId
    • Description: Gets a negative keyword list given an advertiser ID and a negative keyword list ID.

  • displayvideo.advertisers.negativeKeywordLists.delete

      Parameters:

        advertiserId

          Pattern: ^[^/]+$

          Format: int64

          Description: Required. The ID of the DV360 advertiser to which the negative keyword list belongs.

          Required: Yes

          Type: string

          Location: path

        negativeKeywordListId

          Description: Required. The ID of the negative keyword list to delete.

          Pattern: ^[^/]+$

          Location: path

          Format: int64

          Required: Yes

          Type: string

      Path: v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}

      Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}

      Description: Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.

      Parameter Order:

    • advertiserId
    • negativeKeywordListId
    • HTTP Method: DELETE

  • displayvideo.advertisers.negativeKeywordLists.list

      Path: v3/advertisers/{+advertiserId}/negativeKeywordLists

      Parameters:

        pageSize

          Format: int32

          Location: query

          Type: integer

          Description: Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

        pageToken

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.

          Type: string

        advertiserId

          Format: int64

          Description: Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.

          Type: string

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

      Description: Lists negative keyword lists based on a given advertiser id.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: advertiserId

      Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists

      HTTP Method: GET

  • displayvideo.advertisers.negativeKeywordLists.patch

      Parameter Order:

    • advertiserId
    • negativeKeywordListId
    • Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}

      HTTP Method: PATCH

      Parameters:

        updateMask

          Location: query

          Format: google-fieldmask

          Type: string

          Description: Required. The mask to control which fields to update.

        advertiserId

          Required: Yes

          Format: int64

          Pattern: ^[^/]+$

          Location: path

          Description: Required. The ID of the DV360 advertiser to which the negative keyword list belongs.

          Type: string

        negativeKeywordListId

          Type: string

          Location: path

          Description: Output only. The unique ID of the negative keyword list. Assigned by the system.

          Required: Yes

          Format: int64

      Path: v3/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}

      Description: Updates a negative keyword list. Returns the updated negative keyword list if successful.

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.advertisers.adGroups.list

      Path: v3/advertisers/{+advertiserId}/adGroups

      Flat Path: v3/advertisers/{advertisersId}/adGroups

      Parameter Order: advertiserId

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: GET

      Parameters:

        filter

          Description: Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

        pageToken

          Description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned.

          Type: string

          Location: query

        orderBy

          Type: string

          Location: query

          Description: Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

        pageSize

          Type: integer

          Location: query

          Description: Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Format: int32

        advertiserId

          Format: int64

          Required: Yes

          Description: Required. The ID of the advertiser the ad groups belongs to.

          Pattern: ^[^/]+$

          Type: string

          Location: path

      Description: Lists ad groups.

  • displayvideo.advertisers.adGroups.bulkListAdGroupAssignedTargetingOptions

      Description: Lists assigned targeting options for multiple ad groups across targeting types. Inherieted assigned targeting options are not included.

      Parameters:

        pageSize

          Location: query

          Format: int32

          Description: Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Type: integer

        filter

          Description: Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

        advertiserId

          Location: path

          Pattern: ^[^/]+$

          Format: int64

          Type: string

          Description: Required. The ID of the advertiser the line items belongs to.

          Required: Yes

        pageToken

          Description: Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

          Location: query

          Type: string

        adGroupIds

          Repeated: Yes

          Format: int64

          Location: query

          Description: Required. The IDs of the ad groups to list assigned targeting options for.

          Type: string

        orderBy

          Location: query

          Description: Optional. Field by which to sort the list. Acceptable values are: * `youtubeAdGroupId` (acceptable in v2) * `adGroupId` (acceptable in v3) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.

          Type: string

      Parameter Order: advertiserId

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: GET

      Flat Path: v3/advertisers/{advertisersId}/adGroups:bulkListAdGroupAssignedTargetingOptions

      Path: v3/advertisers/{+advertiserId}/adGroups:bulkListAdGroupAssignedTargetingOptions

  • displayvideo.advertisers.adGroups.get

      Description: Gets an ad group.

      Flat Path: v3/advertisers/{advertisersId}/adGroups/{adGroupsId}

      Parameter Order:

    • advertiserId
    • adGroupId
    • Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: GET

      Path: v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}

      Parameters:

        advertiserId

          Pattern: ^[^/]+$

          Location: path

          Type: string

          Required: Yes

          Format: int64

          Description: Required. The ID of the advertiser this ad group belongs to.

        adGroupId

          Pattern: ^[^/]+$

          Description: Required. The ID of the ad group to fetch.

          Type: string

          Location: path

          Required: Yes

          Format: int64

  • displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get

      Description: Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: GET

      Parameters:

        advertiserId

          Pattern: ^[^/]+$

          Description: Required. The ID of the advertiser the ad group belongs to.

          Location: path

          Format: int64

          Required: Yes

          Type: string

        assignedTargetingOptionId

          Pattern: ^[^/]+$

          Description: Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.

          Required: Yes

          Location: path

          Type: string

        adGroupId

          Pattern: ^[^/]+$

          Required: Yes

          Location: path

          Format: int64

          Type: string

          Description: Required. The ID of the ad group the assigned targeting option belongs to.

        targetingType

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Pattern: ^[^/]+$

          Required: Yes

          Type: string

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`

          Location: path

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION

      Path: v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

      Parameter Order:

    • advertiserId
    • adGroupId
    • targetingType
    • assignedTargetingOptionId
    • Flat Path: v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

  • displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list

      Parameter Order:

    • advertiserId
    • adGroupId
    • targetingType
    • HTTP Method: GET

      Parameters:

        filter

          Type: string

          Location: query

          Description: Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        targetingType

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Type: string

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Required: Yes

          Pattern: ^[^/]+$

          Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`

          Location: path

        adGroupId

          Format: int64

          Location: path

          Pattern: ^[^/]+$

          Required: Yes

          Type: string

          Description: Required. The ID of the ad group to list assigned targeting options for.

        pageToken

          Description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

          Location: query

          Type: string

        advertiserId

          Location: path

          Type: string

          Pattern: ^[^/]+$

          Required: Yes

          Description: Required. The ID of the advertiser the ad group belongs to.

          Format: int64

        orderBy

          Type: string

          Description: Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.

          Location: query

        pageSize

          Description: Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Type: integer

          Format: int32

          Location: query

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      Flat Path: v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

      Description: Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.

  • displayvideo.partners.list

      Description: Lists partners that are accessible to the current user. The order is defined by the order_by parameter.

      Parameters:

        pageSize

          Format: int32

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.

          Location: query

          Type: integer

        pageToken

          Location: query

          Type: string

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results will be returned.

        filter

          Type: string

          Location: query

          Description: Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        orderBy

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.

          Location: query

      Flat Path: v3/partners

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/partners

  • displayvideo.partners.get

      Parameter Order: partnerId

      Parameters:

        partnerId

          Required: Yes

          Description: Required. The ID of the partner to fetch.

          Format: int64

          Type: string

          Location: path

          Pattern: ^[^/]+$

      HTTP Method: GET

      Path: v3/partners/{+partnerId}

      Flat Path: v3/partners/{partnersId}

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Gets a partner.

  • displayvideo.partners.editAssignedTargetingOptions

      HTTP Method: POST

      Path: v3/partners/{+partnerId}:editAssignedTargetingOptions

      Flat Path: v3/partners/{partnersId}:editAssignedTargetingOptions

      Description: Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .

      Parameters:

        partnerId

          Description: Required. The ID of the partner.

          Format: int64

          Pattern: ^[^/]+$

          Type: string

          Location: path

          Required: Yes

      Parameter Order: partnerId

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.partners.channels.patch

      Parameters:

        partnerId

          Description: The ID of the partner that owns the created channel.

          Location: path

          Type: string

          Pattern: ^[^/]+$

          Format: int64

          Required: Yes

        advertiserId

          Description: The ID of the advertiser that owns the created channel.

          Type: string

          Location: query

          Format: int64

        updateMask

          Type: string

          Format: google-fieldmask

          Description: Required. The mask to control which fields to update.

          Location: query

        channelId

          Description: Output only. The unique ID of the channel. Assigned by the system.

          Format: int64

          Location: path

          Type: string

          Required: Yes

      Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/partners/{+partnerId}/channels/{channelId}

      HTTP Method: PATCH

      Parameter Order:

    • partnerId
    • channelId
    • Description: Updates a channel. Returns the updated channel if successful.

      Flat Path: v3/partners/{partnersId}/channels/{channelId}

  • displayvideo.partners.channels.get

      HTTP Method: GET

      Parameter Order:

    • partnerId
    • channelId
    • Description: Gets a channel for a partner or advertiser.

      Flat Path: v3/partners/{partnersId}/channels/{channelsId}

      Path: v3/partners/{+partnerId}/channels/{+channelId}

      Scopes: https://www.googleapis.com/auth/display-video

      Parameters:

        partnerId

          Type: string

          Format: int64

          Required: Yes

          Description: The ID of the partner that owns the fetched channel.

          Location: path

          Pattern: ^[^/]+$

        advertiserId

          Type: string

          Description: The ID of the advertiser that owns the fetched channel.

          Location: query

          Format: int64

        channelId

          Type: string

          Pattern: ^[^/]+$

          Required: Yes

          Description: Required. The ID of the channel to fetch.

          Format: int64

          Location: path

  • displayvideo.partners.channels.list

      HTTP Method: GET

      Parameters:

        advertiserId

          Type: string

          Format: int64

          Description: The ID of the advertiser that owns the channels.

          Location: query

        pageSize

          Location: query

          Format: int32

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Type: integer

        partnerId

          Format: int64

          Type: string

          Pattern: ^[^/]+$

          Description: The ID of the partner that owns the channels.

          Location: path

          Required: Yes

        filter

          Type: string

          Location: query

          Description: Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        orderBy

          Location: query

          Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`.

          Type: string

        pageToken

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.

          Type: string

          Location: query

      Flat Path: v3/partners/{partnersId}/channels

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Lists channels for a partner or advertiser.

      Parameter Order: partnerId

      Path: v3/partners/{+partnerId}/channels

  • displayvideo.partners.channels.create

      HTTP Method: POST

      Flat Path: v3/partners/{partnersId}/channels

      Parameter Order: partnerId

      Description: Creates a new channel. Returns the newly created channel if successful.

      Path: v3/partners/{+partnerId}/channels

      Scopes: https://www.googleapis.com/auth/display-video

      Parameters:

        advertiserId

          Location: query

          Description: The ID of the advertiser that owns the created channel.

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the created channel.

          Pattern: ^[^/]+$

          Required: Yes

          Type: string

          Location: path

          Format: int64

  • displayvideo.partners.channels.sites.create

      Path: v3/partners/{partnerId}/channels/{+channelId}/sites

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • partnerId
    • channelId
    • Flat Path: v3/partners/{partnerId}/channels/{channelsId}/sites

      HTTP Method: POST

      Parameters:

        advertiserId

          Description: The ID of the advertiser that owns the parent channel.

          Location: query

          Format: int64

          Type: string

        channelId

          Location: path

          Required: Yes

          Format: int64

          Description: Required. The ID of the parent channel in which the site will be created.

          Type: string

          Pattern: ^[^/]+$

        partnerId

          Format: int64

          Description: The ID of the partner that owns the parent channel.

          Type: string

          Required: Yes

          Location: path

      Description: Creates a site in a channel.

  • displayvideo.partners.channels.sites.replace

      Parameters:

        channelId

          Type: string

          Pattern: ^[^/]+$

          Location: path

          Format: int64

          Required: Yes

          Description: Required. The ID of the parent channel whose sites will be replaced.

        partnerId

          Location: path

          Description: The ID of the partner that owns the parent channel.

          Type: string

          Required: Yes

          Format: int64

      Description: Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • partnerId
    • channelId
    • Flat Path: v3/partners/{partnerId}/channels/{channelsId}/sites:replace

      HTTP Method: POST

      Path: v3/partners/{partnerId}/channels/{+channelId}/sites:replace

  • displayvideo.partners.channels.sites.delete

      Parameters:

        urlOrAppId

          Type: string

          Pattern: ^[^/]+$

          Required: Yes

          Description: Required. The URL or app ID of the site to delete.

          Location: path

        partnerId

          Required: Yes

          Type: string

          Description: The ID of the partner that owns the parent channel.

          Location: path

          Format: int64

        channelId

          Description: Required. The ID of the parent channel to which the site belongs.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

          Location: query

          Format: int64

          Type: string

          Description: The ID of the advertiser that owns the parent channel.

      Description: Deletes a site from a channel.

      Scopes: https://www.googleapis.com/auth/display-video

      HTTP Method: DELETE

      Path: v3/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}

      Parameter Order:

    • partnerId
    • channelId
    • urlOrAppId
    • Flat Path: v3/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}

  • displayvideo.partners.channels.sites.list

      Path: v3/partners/{+partnerId}/channels/{+channelId}/sites

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • partnerId
    • channelId
    • Description: Lists sites in a channel.

      Parameters:

        orderBy

          Type: string

          Location: query

          Description: Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.

        pageToken

          Type: string

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.

        channelId

          Location: path

          Required: Yes

          Format: int64

          Description: Required. The ID of the parent channel to which the requested sites belong.

          Type: string

          Pattern: ^[^/]+$

        partnerId

          Type: string

          Description: The ID of the partner that owns the parent channel.

          Required: Yes

          Location: path

          Pattern: ^[^/]+$

          Format: int64

        advertiserId

          Format: int64

          Description: The ID of the advertiser that owns the parent channel.

          Type: string

          Location: query

        pageSize

          Type: integer

          Location: query

          Description: Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Format: int32

        filter

          Type: string

          Description: Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

      Flat Path: v3/partners/{partnersId}/channels/{channelsId}/sites

      HTTP Method: GET

  • displayvideo.partners.channels.sites.bulkEdit

      Parameters:

        partnerId

          Required: Yes

          Description: The ID of the partner that owns the parent channel.

          Type: string

          Format: int64

          Location: path

        channelId

          Description: Required. The ID of the parent channel to which the sites belong.

          Required: Yes

          Type: string

          Location: path

          Format: int64

          Pattern: ^[^/]+$

      Flat Path: v3/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit

      Description: Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

      Parameter Order:

    • partnerId
    • channelId
    • Scopes: https://www.googleapis.com/auth/display-video

      Path: v3/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit

      HTTP Method: POST

  • displayvideo.partners.targetingTypes.assignedTargetingOptions.delete

      HTTP Method: DELETE

      Path: v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

      Scopes: https://www.googleapis.com/auth/display-video

      Description: Deletes an assigned targeting option from a partner.

      Parameters:

        assignedTargetingOptionId

          Description: Required. The ID of the assigned targeting option to delete.

          Pattern: ^[^/]+$

          Required: Yes

          Type: string

          Location: path

        partnerId

          Pattern: ^[^/]+$

          Required: Yes

          Description: Required. The ID of the partner.

          Type: string

          Format: int64

          Location: path

        targetingType

          Required: Yes

          Pattern: ^[^/]+$

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Type: string

          Location: path

      Flat Path: v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

      Parameter Order:

    • partnerId
    • targetingType
    • assignedTargetingOptionId
  • displayvideo.partners.targetingTypes.assignedTargetingOptions.get

      HTTP Method: GET

      Description: Gets a single targeting option assigned to a partner.

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order:

    • partnerId
    • targetingType
    • assignedTargetingOptionId
    • Flat Path: v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

      Parameters:

        targetingType

          Type: string

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Pattern: ^[^/]+$

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`

          Required: Yes

          Location: path

        partnerId

          Format: int64

          Pattern: ^[^/]+$

          Type: string

          Description: Required. The ID of the partner.

          Location: path

          Required: Yes

        assignedTargetingOptionId

          Location: path

          Type: string

          Pattern: ^[^/]+$

          Description: Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.

          Required: Yes

      Path: v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

  • displayvideo.partners.targetingTypes.assignedTargetingOptions.list

      Description: Lists the targeting options assigned to a partner.

      Flat Path: v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

      Path: v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      HTTP Method: GET

      Parameter Order:

    • partnerId
    • targetingType
    • Parameters:

        filter

          Location: query

          Type: string

          Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

        pageToken

          Type: string

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

        targetingType

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Pattern: ^[^/]+$

          Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
        • Required: Yes

          Location: path

          Type: string

        partnerId

          Pattern: ^[^/]+$

          Required: Yes

          Description: Required. The ID of the partner.

          Type: string

          Format: int64

          Location: path

        pageSize

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Location: query

          Type: integer

          Format: int32

        orderBy

          Location: query

          Type: string

          Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.partners.targetingTypes.assignedTargetingOptions.create

      Flat Path: v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

      Parameter Order:

    • partnerId
    • targetingType
    • HTTP Method: POST

      Path: v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions

      Description: Assigns a targeting option to a partner. Returns the assigned targeting option if successful.

      Parameters:

        targetingType

          Required: Yes

          Pattern: ^[^/]+$

          Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`

          Type: string

          Enum:

        • TARGETING_TYPE_UNSPECIFIED
        • TARGETING_TYPE_CHANNEL
        • TARGETING_TYPE_APP_CATEGORY
        • TARGETING_TYPE_APP
        • TARGETING_TYPE_URL
        • TARGETING_TYPE_DAY_AND_TIME
        • TARGETING_TYPE_AGE_RANGE
        • TARGETING_TYPE_REGIONAL_LOCATION_LIST
        • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
        • TARGETING_TYPE_GENDER
        • TARGETING_TYPE_VIDEO_PLAYER_SIZE
        • TARGETING_TYPE_USER_REWARDED_CONTENT
        • TARGETING_TYPE_PARENTAL_STATUS
        • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
        • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
        • TARGETING_TYPE_DEVICE_TYPE
        • TARGETING_TYPE_AUDIENCE_GROUP
        • TARGETING_TYPE_BROWSER
        • TARGETING_TYPE_HOUSEHOLD_INCOME
        • TARGETING_TYPE_ON_SCREEN_POSITION
        • TARGETING_TYPE_THIRD_PARTY_VERIFIER
        • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
        • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
        • TARGETING_TYPE_ENVIRONMENT
        • TARGETING_TYPE_CARRIER_AND_ISP
        • TARGETING_TYPE_OPERATING_SYSTEM
        • TARGETING_TYPE_DEVICE_MAKE_MODEL
        • TARGETING_TYPE_KEYWORD
        • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
        • TARGETING_TYPE_VIEWABILITY
        • TARGETING_TYPE_CATEGORY
        • TARGETING_TYPE_INVENTORY_SOURCE
        • TARGETING_TYPE_LANGUAGE
        • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
        • TARGETING_TYPE_GEO_REGION
        • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
        • TARGETING_TYPE_EXCHANGE
        • TARGETING_TYPE_SUB_EXCHANGE
        • TARGETING_TYPE_POI
        • TARGETING_TYPE_BUSINESS_CHAIN
        • TARGETING_TYPE_CONTENT_DURATION
        • TARGETING_TYPE_CONTENT_STREAM_TYPE
        • TARGETING_TYPE_NATIVE_CONTENT_POSITION
        • TARGETING_TYPE_OMID
        • TARGETING_TYPE_AUDIO_CONTENT_TYPE
        • TARGETING_TYPE_CONTENT_GENRE
        • TARGETING_TYPE_YOUTUBE_VIDEO
        • TARGETING_TYPE_YOUTUBE_CHANNEL
        • TARGETING_TYPE_SESSION_POSITION
        • Location: path

          Enum Descriptions:

        • Default value when type is not specified or is unknown in this version.
        • Target a channel (a custom group of related websites or apps).
        • Target an app category (for example, education or puzzle games).
        • Target a specific app (for example, Angry Birds).
        • Target a specific url (for example, quora.com).
        • Target ads during a chosen time period on a specific day.
        • Target ads to a specific age range (for example, 18-24).
        • Target ads to the specified regions on a regional location list.
        • Target ads to the specified points of interest on a proximity location list.
        • Target ads to a specific gender (for example, female or male).
        • Target a specific video player size for video ads.
        • Target user rewarded content for video ads.
        • Target ads to a specific parental status (for example, parent or not a parent).
        • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
        • Target ads in a specific content outstream position.
        • Target ads to a specific device type (for example, tablet or connected TV).
        • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
        • Target ads to specific web browsers (for example, Chrome).
        • Target ads to a specific household income range (for example, top 10%).
        • Target ads in a specific on screen position.
        • Filter web sites through third party verification (for example, IAS or DoubleVerify).
        • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
        • Filter website content by sensitive categories (for example, adult).
        • Target ads to a specific environment (for example, web or app).
        • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
        • Target ads to a specific operating system (for example, macOS).
        • Target ads to a specific device make or model (for example, Roku or Samsung).
        • Target ads to a specific keyword (for example, dog or retriever).
        • Target ads to a specific negative keyword list.
        • Target ads to a specific viewability (for example, 80% viewable).
        • Target ads to a specific content category (for example, arts & entertainment).
        • Purchase impressions from specific deals and auction packages.
        • Target ads to a specific language (for example, English or Japanese).
        • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
        • Target ads to a specific regional location (for example, a city or state).
        • Purchase impressions from a group of deals and auction packages.
        • Purchase impressions from specific exchanges.
        • Purchase impressions from specific sub-exchanges.
        • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
        • Target ads around locations of a business chain within a specific geo region.
        • Target ads to a specific video content duration.
        • Target ads to a specific video content stream type.
        • Target ads to a specific native content position.
        • Target ads in an Open Measurement enabled inventory.
        • Target ads to a specific audio content type.
        • Target ads to a specific content genre.
        • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
        • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.

        partnerId

          Format: int64

          Required: Yes

          Description: Required. The ID of the partner.

          Pattern: ^[^/]+$

          Type: string

          Location: path

      Scopes: https://www.googleapis.com/auth/display-video

  • displayvideo.googleAudiences.list

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/display-video

      Flat Path: v3/googleAudiences

      Description: Lists Google audiences. The order is defined by the order_by parameter.

      Path: v3/googleAudiences

      Parameters:

        pageSize

          Format: int32

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

          Location: query

          Type: integer

        partnerId

          Type: string

          Location: query

          Description: The ID of the partner that has access to the fetched Google audiences.

          Format: int64

        filter

          Location: query

          Description: Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Type: string

        pageToken

          Location: query

          Type: string

          Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned.

        advertiserId

          Format: int64

          Location: query

          Description: The ID of the advertiser that has access to the fetched Google audiences.

          Type: string

        orderBy

          Description: Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

          Type: string

          Location: query

  • displayvideo.googleAudiences.get

      Parameters:

        partnerId

          Description: The ID of the partner that has access to the fetched Google audience.

          Format: int64

          Type: string

          Location: query

        googleAudienceId

          Type: string

          Description: Required. The ID of the Google audience to fetch.

          Required: Yes

          Location: path

          Pattern: ^[^/]+$

          Format: int64

        advertiserId

          Description: The ID of the advertiser that has access to the fetched Google audience.

          Type: string

          Location: query

          Format: int64

      HTTP Method: GET

      Flat Path: v3/googleAudiences/{googleAudiencesId}

      Scopes: https://www.googleapis.com/auth/display-video

      Parameter Order: googleAudienceId

      Description: Gets a Google audience.

      Path: v3/googleAudiences/{+googleAudienceId}

  • displayvideo.inventorySources.list

      Path: v3/inventorySources

      Description: Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.

      Flat Path: v3/inventorySources

      Parameters:

        partnerId

          Format: int64

          Type: string

          Location: query

          Description: The ID of the partner that has access to the inventory source.

        pageSize

          Type: integer

          Location: query

          Format: int32

          Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.

        advertiserId

          Location: query

          Description: The ID of the advertiser that has access to the inventory source.

          Format: int64

          Type: string

        filter

          Location: query

          Type: string