Display & Video 360 API (displayvideo:v1)

2024-02-16

150 removed methods | Removed API

Deletions

    Methods
  • displayvideo.advertisers.bulkListAdvertiserAssignedTargetingOptions

      Path: v1/advertisers/{+advertiserId}:bulkListAdvertiserAssignedTargetingOptions

      Flat Path: v1/advertisers/{advertisersId}:bulkListAdvertiserAssignedTargetingOptions

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

          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

          Type: integer

          Format: int32

        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 `BulkListAdvertiserAssignedTargetingOptions` 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: * `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

          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: * `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.

          Location: query

          Type: string

      Parameter Order: advertiserId

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

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

  • displayvideo.advertisers.bulkEditAdvertiserAssignedTargetingOptions

      Path: v1/advertisers/{+advertiserId}:bulkEditAdvertiserAssignedTargetingOptions

      Flat Path: v1/advertisers/{advertisersId}:bulkEditAdvertiserAssignedTargetingOptions

      HTTP Method: POST

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

      Description: Bulk 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 .

  • displayvideo.advertisers.get

      Path: v1/advertisers/{+advertiserId}

      Flat Path: v1/advertisers/{advertisersId}

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

      Description: Gets an advertiser.

  • displayvideo.advertisers.list

      Path: v1/advertisers

      Flat Path: v1/advertisers

      HTTP Method: GET

      Parameters:

        partnerId

          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.

          Location: query

          Type: string

          Format: int64

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        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

        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

      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.

  • displayvideo.advertisers.create

      Path: v1/advertisers

      Flat Path: v1/advertisers

      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.

  • displayvideo.advertisers.patch

      Path: v1/advertisers/{+advertiserId}

      Flat Path: v1/advertisers/{advertisersId}

      HTTP Method: PATCH

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: advertiserId

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

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

  • displayvideo.advertisers.delete

      Path: v1/advertisers/{+advertiserId}

      Flat Path: v1/advertisers/{advertisersId}

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

      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: v1/advertisers/{+advertiserId}:audit

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        readMask

          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

          Format: google-fieldmask

      Parameter Order: advertiserId

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

      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.

  • displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions

      Path: v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions

      Flat Path: v1/advertisers/{advertisersId}/lineItems/{lineItemsId}:bulkListLineItemAssignedTargetingOptions

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

          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

          Type: integer

          Format: int32

        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 `BulkListLineItemAssignedTargetingOptions` 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: * `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

          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 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.

          Location: query

          Type: string

      Parameter Order:

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

      Description: Lists assigned targeting options of a line item across targeting types.

  • displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions

      Path: v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions

      Flat Path: v1/advertisers/{advertisersId}/lineItems/{lineItemsId}:bulkEditLineItemAssignedTargetingOptions

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.

  • displayvideo.advertisers.lineItems.get

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Gets a line item.

  • displayvideo.advertisers.lineItems.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        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

        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 `ListLineItems` 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: * `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

        filter

          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.

          Location: query

          Type: string

      Parameter Order: advertiserId

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

      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.

  • displayvideo.advertisers.lineItems.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

      Description: Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.

  • displayvideo.advertisers.lineItems.patch

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

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

      HTTP Method: PATCH

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

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

      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 YouTube & Partners line items cannot be created or updated using the API.

  • displayvideo.advertisers.lineItems.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

          Description: The ID of the line item to delete.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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. YouTube & Partners line items cannot be created or updated using the API.

  • displayvideo.advertisers.lineItems.generateDefault

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

      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 YouTube & Partners line items cannot be created or updated using the API.

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

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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)

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        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

      Parameter Order:

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

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

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

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        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)

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        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.

          Location: query

          Type: integer

          Format: int32

        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.

          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

        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 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

          Type: string

      Parameter Order:

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

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

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

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

      Parameter Order:

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

      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 YouTube & Partners line items cannot be created or updated using the API.

  • displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        lineItemId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        assignedTargetingOptionId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

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

      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 YouTube & Partners line items cannot be created or updated using the API.

  • displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        assignedTargetingOptionId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

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

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

  • displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        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.

          Location: query

          Type: integer

          Format: int32

        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

        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

        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

      Parameter Order:

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

      Description: Lists the targeting options assigned to an advertiser.

  • displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

      Parameter Order:

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

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

  • displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        assignedTargetingOptionId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

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

      Description: Deletes an assigned targeting option from an advertiser.

  • displayvideo.advertisers.assets.upload

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

      Supportsmediaupload: Yes

      Mediaupload:

        Accept: */*

        Protocols:

          Simple:

            Multipart: Yes

            Path: /upload/v1/advertisers/{+advertiserId}/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).

  • displayvideo.advertisers.campaigns.bulkListCampaignAssignedTargetingOptions

      Path: v1/advertisers/{+advertiserId}/campaigns/{+campaignId}:bulkListCampaignAssignedTargetingOptions

      Flat Path: v1/advertisers/{advertisersId}/campaigns/{campaignsId}:bulkListCampaignAssignedTargetingOptions

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        campaignId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

          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

          Type: integer

          Format: int32

        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 `BulkListCampaignAssignedTargetingOptions` 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: * `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

          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: * `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

          Type: string

      Parameter Order:

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

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

  • displayvideo.advertisers.campaigns.get

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        campaignId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

    • advertiserId
    • campaignId
    • Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Description: Gets a campaign.

  • displayvideo.advertisers.campaigns.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        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 `ListCampaigns` 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: * `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

        filter

          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.

          Location: query

          Type: string

      Parameter Order: advertiserId

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • 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.campaigns.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

      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

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

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

      HTTP Method: PATCH

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        campaignId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

    • advertiserId
    • campaignId
    • Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Description: Updates an existing campaign. Returns the updated campaign if successful.

  • displayvideo.advertisers.campaigns.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        campaignId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

    • advertiserId
    • campaignId
    • Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • 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.

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

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        campaignId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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

          Required: Yes

          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.
        • 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

        assignedTargetingOptionId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

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

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

  • displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        campaignId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        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.

          Location: query

          Type: integer

          Format: int32

        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 `ListCampaignAssignedTargetingOptions` 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

        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

      Parameter Order:

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

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

  • displayvideo.advertisers.channels.get

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Gets a channel for a partner or advertiser.

  • displayvideo.advertisers.channels.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

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

          Location: query

          Type: string

          Format: int64

        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

        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

        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

        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.

          Location: query

          Type: string

      Parameter Order: advertiserId

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

      Description: Lists channels for a partner or advertiser.

  • displayvideo.advertisers.channels.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

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

  • displayvideo.advertisers.channels.patch

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

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

      HTTP Method: PATCH

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

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

          Location: query

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

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

      Description: Updates a channel. Returns the updated channel if successful.

  • displayvideo.advertisers.channels.sites.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

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

          Location: query

          Type: string

          Format: int64

        pageSize

          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

          Type: integer

          Format: int32

        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.

          Location: query

          Type: string

        orderBy

          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

          Type: string

        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

      Parameter Order:

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

      Description: Lists sites in a channel.

  • displayvideo.advertisers.channels.sites.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Creates a site in a channel.

  • displayvideo.advertisers.channels.sites.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          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

        urlOrAppId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

        partnerId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Deletes a site from a channel.

  • displayvideo.advertisers.channels.sites.bulkEdit

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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.sites.replace

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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.

  • displayvideo.advertisers.creatives.get

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        creativeId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Gets a creative.

  • displayvideo.advertisers.creatives.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        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

        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 `ListCreatives` 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: * `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

          Type: string

        filter

          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.

          Location: query

          Type: string

      Parameter Order: advertiserId

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

      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.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

      Description: Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.

  • displayvideo.advertisers.creatives.patch

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

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

      HTTP Method: PATCH

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        creativeId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

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

      Description: Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.

  • displayvideo.advertisers.creatives.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        creativeId

          Description: The ID of the creative to be deleted.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.

  • displayvideo.advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions

      Path: v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:bulkListInsertionOrderAssignedTargetingOptions

      Flat Path: v1/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}:bulkListInsertionOrderAssignedTargetingOptions

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        insertionOrderId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

          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

          Type: integer

          Format: int32

        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.

          Location: query

          Type: string

        orderBy

          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

          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 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.

          Location: query

          Type: string

      Parameter Order:

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

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

  • displayvideo.advertisers.insertionOrders.get

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        insertionOrderId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

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

  • displayvideo.advertisers.insertionOrders.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

          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.

          Location: query

          Type: integer

          Format: int32

        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 `ListInsertionOrders` 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: * "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

        filter

          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

          Type: string

      Parameter Order: advertiserId

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

      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.

  • displayvideo.advertisers.insertionOrders.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

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

  • displayvideo.advertisers.insertionOrders.patch

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

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

      HTTP Method: PATCH

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        insertionOrderId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

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

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

  • displayvideo.advertisers.insertionOrders.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        insertionOrderId

          Description: The ID of the insertion order to delete.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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.

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

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        insertionOrderId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

          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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        assignedTargetingOptionId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

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

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

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

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        insertionOrderId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        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`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        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.

          Location: query

          Type: integer

          Format: int32

        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

        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 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

          Type: string

      Parameter Order:

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

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

  • displayvideo.advertisers.invoices.list

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

      Flat Path: v1/advertisers/{advertisersId}/invoices

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        issueMonth

          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.

          Location: query

          Type: string

        loiSapinInvoiceType

          Description: Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.

          Location: query

          Type: string

          Enum Descriptions:

        • Value is not specified.
        • Invoices with Media cost.
        • Invoices with Platform fee.
        • Enum:

        • LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED
        • LOI_SAPIN_INVOICE_TYPE_MEDIA
        • LOI_SAPIN_INVOICE_TYPE_PLATFORM

        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

        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 `ListInvoices` method. If not specified, the first page of results will be returned.

          Location: query

          Type: string

      Parameter Order: advertiserId

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • 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

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        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

      Parameter Order: advertiserId

      Scopes:

    • https://www.googleapis.com/auth/display-video
    • https://www.googleapis.com/auth/display-video-mediaplanning
    • Description: Retrieves the invoice currency used by an advertiser in a given month.

  • displayvideo.advertisers.locationLists.get

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        locationListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Gets a location list.

  • displayvideo.advertisers.locationLists.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

          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.

          Location: query

          Type: integer

          Format: int32

        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.

          Location: query

          Type: string

        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`.

          Location: query

          Type: string

        filter

          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.

          Location: query

          Type: string

      Parameter Order: advertiserId

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

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

  • displayvideo.advertisers.locationLists.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

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

  • displayvideo.advertisers.locationLists.patch

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

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

      HTTP Method: PATCH

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        locationListId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

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

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

  • displayvideo.advertisers.locationLists.assignedLocations.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        locationListId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        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

        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 `ListAssignedLocations` 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: * `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`.

          Location: query

          Type: string

        filter

          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

          Type: string

      Parameter Order:

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

      Description: Lists locations assigned to a location list.

  • displayvideo.advertisers.locationLists.assignedLocations.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        locationListId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

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

  • displayvideo.advertisers.locationLists.assignedLocations.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        locationListId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        assignedLocationId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

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

  • displayvideo.advertisers.locationLists.assignedLocations.bulkEdit

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        locationListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

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

  • displayvideo.advertisers.manualTriggers.get

      Path: v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}

      Flat Path: v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        triggerId

          Description: Required. The ID of the manual trigger to fetch.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Gets a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.

  • displayvideo.advertisers.manualTriggers.list

      Path: v1/advertisers/{+advertiserId}/manualTriggers

      Flat Path: v1/advertisers/{advertisersId}/manualTriggers

      HTTP Method: GET

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser that the fetched manual triggers belong to.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        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 `ListManualTriggers` 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: * `displayName` (default) * `state` 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 manual trigger 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: * `displayName` * `state` Examples: * All active manual triggers under an advertiser: `state="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.

          Location: query

          Type: string

      Parameter Order: advertiserId

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

      Description: Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.

  • displayvideo.advertisers.manualTriggers.create

      Path: v1/advertisers/{+advertiserId}/manualTriggers

      Flat Path: v1/advertisers/{advertisersId}/manualTriggers

      HTTP Method: POST

      Parameters:

        advertiserId

          Description: Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

      Description: Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.

  • displayvideo.advertisers.manualTriggers.patch

      Path: v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}

      Flat Path: v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}

      HTTP Method: PATCH

      Parameters:

        advertiserId

          Description: Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        triggerId

          Description: Output only. The unique ID of the manual trigger.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

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

      Description: Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.

  • displayvideo.advertisers.manualTriggers.activate

      Path: v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:activate

      Flat Path: v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:activate

      HTTP Method: POST

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser that the manual trigger belongs.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        triggerId

          Description: Required. The ID of the manual trigger to activate.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.

  • displayvideo.advertisers.manualTriggers.deactivate

      Path: v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:deactivate

      Flat Path: v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:deactivate

      HTTP Method: POST

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser that the manual trigger belongs.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        triggerId

          Description: Required. The ID of the manual trigger to deactivate.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Deactivates a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.

  • displayvideo.advertisers.negativeKeywordLists.get

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        negativeKeywordListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

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

  • displayvideo.advertisers.negativeKeywordLists.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

          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.

          Location: query

          Type: integer

          Format: int32

        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 `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.

          Location: query

          Type: string

      Parameter Order: advertiserId

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

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

  • displayvideo.advertisers.negativeKeywordLists.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: advertiserId

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

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

  • displayvideo.advertisers.negativeKeywordLists.patch

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

      Flat Path: v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}

      HTTP Method: PATCH

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        negativeKeywordListId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

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

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

  • displayvideo.advertisers.negativeKeywordLists.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        negativeKeywordListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

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

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list

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

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

      HTTP Method: GET

      Parameters:

        advertiserId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        negativeKeywordListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        pageSize

          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

          Format: int32

        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 `ListNegativeKeywords` 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: * `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

        filter

          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.

          Location: query

          Type: string

      Parameter Order:

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

      Description: Lists negative keywords in a negative keyword list.

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        negativeKeywordListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

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

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete

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

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

      HTTP Method: DELETE

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        negativeKeywordListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        keywordValue

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

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

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

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit

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

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

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        negativeKeywordListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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.

  • displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace

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

      Flat Path: v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace

      HTTP Method: POST

      Parameters:

        advertiserId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        negativeKeywordListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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.

  • displayvideo.combinedAudiences.get

      Path: v1/combinedAudiences/{+combinedAudienceId}

      Flat Path: v1/combinedAudiences/{combinedAudiencesId}

      HTTP Method: GET

      Parameters:

        combinedAudienceId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

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

          Location: query

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order: combinedAudienceId

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

      Description: Gets a combined audience.

  • displayvideo.combinedAudiences.list

      Path: v1/combinedAudiences

      Flat Path: v1/combinedAudiences

      HTTP Method: GET

      Parameters:

        partnerId

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

          Location: query

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

        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

        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 `ListCombinedAudiences` 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: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined 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 combined 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.

          Location: query

          Type: string

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

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

  • displayvideo.customBiddingAlgorithms.get

      Path: v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}

      Flat Path: v1/customBiddingAlgorithms/{customBiddingAlgorithmsId}

      HTTP Method: GET

      Parameters:

        customBiddingAlgorithmId

          Description: Required. The ID of the custom bidding algorithm to fetch.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the DV360 partner that has access to the custom bidding algorithm.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the DV360 partner that has access to the custom bidding algorithm.

          Location: query

          Type: string

          Format: int64

      Parameter Order: customBiddingAlgorithmId

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

      Description: Gets a custom bidding algorithm.

  • displayvideo.customBiddingAlgorithms.list

      Path: v1/customBiddingAlgorithms

      Flat Path: v1/customBiddingAlgorithms

      HTTP Method: GET

      Parameters:

        partnerId

          Description: The ID of the DV360 partner that has access to the custom bidding algorithm.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the DV360 advertiser that has access to the custom bidding algorithm.

          Location: query

          Type: string

          Format: int64

        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

        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 `ListCustomBiddingAlgorithms` 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: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` 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

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

      Description: Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.

  • displayvideo.customBiddingAlgorithms.create

      Path: v1/customBiddingAlgorithms

      Flat Path: v1/customBiddingAlgorithms

      HTTP Method: POST

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

      Description: Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.

  • displayvideo.customBiddingAlgorithms.patch

      Path: v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}

      Flat Path: v1/customBiddingAlgorithms/{customBiddingAlgorithmsId}

      HTTP Method: PATCH

      Parameters:

        customBiddingAlgorithmId

          Description: Output only. The unique ID of the custom bidding algorithm. Assigned by the system.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: customBiddingAlgorithmId

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

      Description: Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.

  • displayvideo.customBiddingAlgorithms.uploadScript

      Path: v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript

      Flat Path: v1/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript

      HTTP Method: GET

      Parameters:

        customBiddingAlgorithmId

          Description: Required. The ID of the custom bidding algorithm owns the script.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the parent custom bidding algorithm.

          Location: query

          Type: string

          Format: int64

      Parameter Order: customBiddingAlgorithmId

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

      Description: Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.

  • displayvideo.customBiddingAlgorithms.scripts.create

      Path: v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts

      Flat Path: v1/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts

      HTTP Method: POST

      Parameters:

        customBiddingAlgorithmId

          Description: Required. The ID of the custom bidding algorithm that owns the script.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the parent custom bidding algorithm.

          Location: query

          Type: string

          Format: int64

      Parameter Order: customBiddingAlgorithmId

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

      Description: Creates a new custom bidding script. Returns the newly created script if successful.

  • displayvideo.customBiddingAlgorithms.scripts.get

      Path: v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}

      Flat Path: v1/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}

      HTTP Method: GET

      Parameters:

        customBiddingAlgorithmId

          Description: Required. The ID of the custom bidding algorithm owns the script.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        customBiddingScriptId

          Description: Required. The ID of the custom bidding script to fetch.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the parent custom bidding algorithm.

          Location: query

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Gets a custom bidding script.

  • displayvideo.customBiddingAlgorithms.scripts.list

      Path: v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts

      Flat Path: v1/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts

      HTTP Method: GET

      Parameters:

        customBiddingAlgorithmId

          Description: Required. The ID of the custom bidding algorithm owns the script.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the parent custom bidding algorithm.

          Location: query

          Type: string

          Format: int64

        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

        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 `ListCustomBiddingScripts` 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: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.

          Location: query

          Type: string

      Parameter Order: customBiddingAlgorithmId

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

      Description: Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.

  • displayvideo.customLists.get

      Path: v1/customLists/{+customListId}

      Flat Path: v1/customLists/{customListsId}

      HTTP Method: GET

      Parameters:

        customListId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the DV360 advertiser that has access to the fetched custom lists.

          Location: query

          Type: string

          Format: int64

      Parameter Order: customListId

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

      Description: Gets a custom list.

  • displayvideo.customLists.list

      Path: v1/customLists

      Flat Path: v1/customLists

      HTTP Method: GET

      Parameters:

        advertiserId

          Description: The ID of the DV360 advertiser that has access to the fetched custom lists.

          Location: query

          Type: string

          Format: int64

        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

        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 `ListCustomLists` 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: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists 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 custom lists 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.

          Location: query

          Type: string

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

      Description: Lists custom lists. The order is defined by the order_by parameter.

  • displayvideo.firstAndThirdPartyAudiences.get

      Path: v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}

      Flat Path: v1/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}

      HTTP Method: GET

      Parameters:

        firstAndThirdPartyAudienceId

          Description: Required. The ID of the first and third party audience to fetch.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that has access to the fetched first and third party audience.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that has access to the fetched first and third party audience.

          Location: query

          Type: string

          Format: int64

      Parameter Order: firstAndThirdPartyAudienceId

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

      Description: Gets a first and third party audience.

  • displayvideo.firstAndThirdPartyAudiences.list

      Path: v1/firstAndThirdPartyAudiences

      Flat Path: v1/firstAndThirdPartyAudiences

      HTTP Method: GET

      Parameters:

        partnerId

          Description: The ID of the partner that has access to the fetched first and third party audiences.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that has access to the fetched first and third party audiences.

          Location: query

          Type: string

          Format: int64

        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

        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 `ListFirstAndThirdPartyAudiences` 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: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party 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 first and third party audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

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

      Description: Lists first and third party audiences. The order is defined by the order_by parameter.

  • displayvideo.firstAndThirdPartyAudiences.create

      Path: v1/firstAndThirdPartyAudiences

      Flat Path: v1/firstAndThirdPartyAudiences

      HTTP Method: POST

      Parameters:

        advertiserId

          Description: Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.

          Location: query

          Type: string

          Format: int64

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

      Description: Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

  • displayvideo.firstAndThirdPartyAudiences.patch

      Path: v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}

      Flat Path: v1/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}

      HTTP Method: PATCH

      Parameters:

        firstAndThirdPartyAudienceId

          Description: Output only. The unique ID of the first and third party audience. Assigned by the system.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

          Description: Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`

          Location: query

          Type: string

          Format: google-fieldmask

        advertiserId

          Description: Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.

          Location: query

          Type: string

          Format: int64

      Parameter Order: firstAndThirdPartyAudienceId

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

      Description: Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

  • displayvideo.firstAndThirdPartyAudiences.editCustomerMatchMembers

      Path: v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers

      Flat Path: v1/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}:editCustomerMatchMembers

      HTTP Method: POST

      Parameters:

        firstAndThirdPartyAudienceId

          Description: Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: firstAndThirdPartyAudienceId

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

      Description: Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

  • displayvideo.floodlightGroups.get

      Path: v1/floodlightGroups/{+floodlightGroupId}

      Flat Path: v1/floodlightGroups/{floodlightGroupsId}

      HTTP Method: GET

      Parameters:

        floodlightGroupId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: Required. The partner context by which the Floodlight group is being accessed.

          Location: query

          Type: string

          Format: int64

      Parameter Order: floodlightGroupId

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

      Description: Gets a Floodlight group.

  • displayvideo.floodlightGroups.patch

      Path: v1/floodlightGroups/{floodlightGroupId}

      Flat Path: v1/floodlightGroups/{floodlightGroupId}

      HTTP Method: PATCH

      Parameters:

        floodlightGroupId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: Required. The partner context by which the Floodlight group is being accessed.

          Location: query

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: floodlightGroupId

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

      Description: Updates an existing Floodlight group. Returns the updated Floodlight group if successful.

  • displayvideo.googleAudiences.get

      Path: v1/googleAudiences/{+googleAudienceId}

      Flat Path: v1/googleAudiences/{googleAudiencesId}

      HTTP Method: GET

      Parameters:

        googleAudienceId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

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

          Location: query

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order: googleAudienceId

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

      Description: Gets a Google audience.

  • displayvideo.googleAudiences.list

      Path: v1/googleAudiences

      Flat Path: v1/googleAudiences

      HTTP Method: GET

      Parameters:

        partnerId

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

          Location: query

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

        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

        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 `ListGoogleAudiences` 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: * `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`.

          Location: query

          Type: string

        filter

          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.

          Location: query

          Type: string

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

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

  • displayvideo.guaranteedOrders.create

      Path: v1/guaranteedOrders

      Flat Path: v1/guaranteedOrders

      HTTP Method: POST

      Parameters:

        partnerId

          Description: The ID of the partner that the request is being made within.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that the request is being made within.

          Location: query

          Type: string

          Format: int64

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

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

  • displayvideo.guaranteedOrders.get

      Path: v1/guaranteedOrders/{+guaranteedOrderId}

      Flat Path: v1/guaranteedOrders/{guaranteedOrdersId}

      HTTP Method: GET

      Parameters:

        guaranteedOrderId

          Description: Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

        partnerId

          Description: The ID of the partner that has access to the guaranteed order.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that has access to the guaranteed order.

          Location: query

          Type: string

          Format: int64

      Parameter Order: guaranteedOrderId

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

      Description: Gets a guaranteed order.

  • displayvideo.guaranteedOrders.list

      Path: v1/guaranteedOrders

      Flat Path: v1/guaranteedOrders

      HTTP Method: GET

      Parameters:

        partnerId

          Description: The ID of the partner that has access to the guaranteed order.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that has access to the guaranteed order.

          Location: query

          Type: string

          Format: int64

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        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 `ListGuaranteedOrders` 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: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by guaranteed order fields. * 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: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

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

      Description: Lists guaranteed orders 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, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.

  • displayvideo.guaranteedOrders.patch

      Path: v1/guaranteedOrders/{+guaranteedOrderId}

      Flat Path: v1/guaranteedOrders/{guaranteedOrdersId}

      HTTP Method: PATCH

      Parameters:

        guaranteedOrderId

          Description: Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

        partnerId

          Description: The ID of the partner that the request is being made within.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that the request is being made within.

          Location: query

          Type: string

          Format: int64

      Parameter Order: guaranteedOrderId

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

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

  • displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors

      Path: v1/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors

      Flat Path: v1/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors

      HTTP Method: POST

      Parameters:

        guaranteedOrderId

          Description: Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: guaranteedOrderId

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

      Description: Edits read advertisers of a guaranteed order.

  • displayvideo.inventorySourceGroups.get

      Path: v1/inventorySourceGroups/{+inventorySourceGroupId}

      Flat Path: v1/inventorySourceGroups/{inventorySourceGroupsId}

      HTTP Method: GET

      Parameters:

        inventorySourceGroupId

          Description: Required. The ID of the inventory source group to fetch.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

          Location: query

          Type: string

          Format: int64

      Parameter Order: inventorySourceGroupId

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

      Description: Gets an inventory source group.

  • displayvideo.inventorySourceGroups.list

      Path: v1/inventorySourceGroups

      Flat Path: v1/inventorySourceGroups

      HTTP Method: GET

      Parameters:

        partnerId

          Description: The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

          Location: query

          Type: string

          Format: int64

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        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 `ListInventorySources` 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: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by inventory source group 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: * `inventorySourceGroupId` 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

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

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

  • displayvideo.inventorySourceGroups.create

      Path: v1/inventorySourceGroups

      Flat Path: v1/inventorySourceGroups

      HTTP Method: POST

      Parameters:

        partnerId

          Description: The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.

          Location: query

          Type: string

          Format: int64

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

      Description: Creates a new inventory source group. Returns the newly created inventory source group if successful.

  • displayvideo.inventorySourceGroups.patch

      Path: v1/inventorySourceGroups/{inventorySourceGroupId}

      Flat Path: v1/inventorySourceGroups/{inventorySourceGroupId}

      HTTP Method: PATCH

      Parameters:

        inventorySourceGroupId

          Description: Output only. The unique ID of the inventory source group. Assigned by the system.

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the inventory source group. Only this partner has write access to this group.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.

          Location: query

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: inventorySourceGroupId

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

      Description: Updates an inventory source group. Returns the updated inventory source group if successful.

  • displayvideo.inventorySourceGroups.delete

      Path: v1/inventorySourceGroups/{+inventorySourceGroupId}

      Flat Path: v1/inventorySourceGroups/{inventorySourceGroupsId}

      HTTP Method: DELETE

      Parameters:

        inventorySourceGroupId

          Description: Required. The ID of the inventory source group to delete.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the inventory source group. Only this partner has write access to this group.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.

          Location: query

          Type: string

          Format: int64

      Parameter Order: inventorySourceGroupId

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

      Description: Deletes an inventory source group.

  • displayvideo.inventorySourceGroups.assignedInventorySources.list

      Path: v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources

      Flat Path: v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources

      HTTP Method: GET

      Parameters:

        inventorySourceGroupId

          Description: Required. The ID of the inventory source group to which these assignments are assigned.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.

          Location: query

          Type: string

          Format: int64

        pageSize

          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.

          Location: query

          Type: integer

          Format: int32

        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 `ListAssignedInventorySources` 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: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` 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

      Parameter Order: inventorySourceGroupId

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

      Description: Lists inventory sources assigned to an inventory source group.

  • displayvideo.inventorySourceGroups.assignedInventorySources.create

      Path: v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources

      Flat Path: v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources

      HTTP Method: POST

      Parameters:

        inventorySourceGroupId

          Description: Required. The ID of the inventory source group to which the assignment will be assigned.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.

          Location: query

          Type: string

          Format: int64

      Parameter Order: inventorySourceGroupId

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

      Description: Creates an assignment between an inventory source and an inventory source group.

  • displayvideo.inventorySourceGroups.assignedInventorySources.delete

      Path: v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}

      Flat Path: v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}

      HTTP Method: DELETE

      Parameters:

        inventorySourceGroupId

          Description: Required. The ID of the inventory source group to which this assignment is assigned.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        assignedInventorySourceId

          Description: Required. The ID of the assigned inventory source to delete.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.

          Location: query

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Deletes the assignment between an inventory source and an inventory source group.

  • displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit

      Path: v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit

      Flat Path: v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit

      HTTP Method: POST

      Parameters:

        inventorySourceGroupId

          Description: Required. The ID of the inventory source group to which the assignments are assigned.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: inventorySourceGroupId

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

      Description: Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.

  • displayvideo.inventorySources.get

      Path: v1/inventorySources/{+inventorySourceId}

      Flat Path: v1/inventorySources/{inventorySourcesId}

      HTTP Method: GET

      Parameters:

        inventorySourceId

          Description: Required. The ID of the inventory source to fetch.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        partnerId

          Description: Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.

          Location: query

          Type: string

          Format: int64

      Parameter Order: inventorySourceId

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

      Description: Gets an inventory source.

  • displayvideo.inventorySources.list

      Path: v1/inventorySources

      Flat Path: v1/inventorySources

      HTTP Method: GET

      Parameters:

        partnerId

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

          Location: query

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        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 `ListInventorySources` 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: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.

          Location: query

          Type: string

        filter

          Description: Allows filtering by inventory source 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: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

          Location: query

          Type: string

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

      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.

  • displayvideo.inventorySources.create

      Path: v1/inventorySources

      Flat Path: v1/inventorySources

      HTTP Method: POST

      Parameters:

        partnerId

          Description: The ID of the partner that the request is being made within.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that the request is being made within.

          Location: query

          Type: string

          Format: int64

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

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

  • displayvideo.inventorySources.patch

      Path: v1/inventorySources/{+inventorySourceId}

      Flat Path: v1/inventorySources/{inventorySourcesId}

      HTTP Method: PATCH

      Parameters:

        inventorySourceId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

        partnerId

          Description: The ID of the partner that the request is being made within.

          Location: query

          Type: string

          Format: int64

        advertiserId

          Description: The ID of the advertiser that the request is being made within.

          Location: query

          Type: string

          Format: int64

      Parameter Order: inventorySourceId

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

      Description: Updates an existing inventory source. Returns the updated inventory source if successful.

  • displayvideo.inventorySources.editInventorySourceReadWriteAccessors

      Path: v1/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors

      Flat Path: v1/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors

      HTTP Method: POST

      Parameters:

        inventorySourceId

          Description: Required. The ID of inventory source to update.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: inventorySourceId

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

      Description: Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.

  • displayvideo.partners.bulkEditPartnerAssignedTargetingOptions

      Path: v1/partners/{+partnerId}:bulkEditPartnerAssignedTargetingOptions

      Flat Path: v1/partners/{partnersId}:bulkEditPartnerAssignedTargetingOptions

      HTTP Method: POST

      Parameters:

        partnerId

          Description: Required. The ID of the partner.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: partnerId

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

      Description: Bulk 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 .

  • displayvideo.partners.get

      Path: v1/partners/{+partnerId}

      Flat Path: v1/partners/{partnersId}

      HTTP Method: GET

      Parameters:

        partnerId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order: partnerId

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

      Description: Gets a partner.

  • displayvideo.partners.list

      Path: v1/partners

      Flat Path: v1/partners

      HTTP Method: GET

      Parameters:

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        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 `ListPartners` 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: * `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

          Type: string

        filter

          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.

          Location: query

          Type: string

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

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

  • displayvideo.partners.channels.get

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

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

      HTTP Method: GET

      Parameters:

        partnerId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Gets a channel for a partner or advertiser.

  • displayvideo.partners.channels.list

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

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

      HTTP Method: GET

      Parameters:

        partnerId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

        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

        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

        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

        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.

          Location: query

          Type: string

      Parameter Order: partnerId

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

      Description: Lists channels for a partner or advertiser.

  • displayvideo.partners.channels.create

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

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

      HTTP Method: POST

      Parameters:

        partnerId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order: partnerId

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

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

  • displayvideo.partners.channels.patch

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

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

      HTTP Method: PATCH

      Parameters:

        partnerId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

        updateMask

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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order:

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

      Description: Updates a channel. Returns the updated channel if successful.

  • displayvideo.partners.channels.sites.list

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

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

      HTTP Method: GET

      Parameters:

        partnerId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

        pageSize

          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

          Type: integer

          Format: int32

        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.

          Location: query

          Type: string

        orderBy

          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

          Type: string

        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

      Parameter Order:

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

      Description: Lists sites in a channel.

  • displayvideo.partners.channels.sites.create

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

      Flat Path: v1/partners/{partnerId}/channels/{channelsId}/sites

      HTTP Method: POST

      Parameters:

        partnerId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        advertiserId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Creates a site in a channel.

  • displayvideo.partners.channels.sites.delete

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

      Flat Path: v1/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}

      HTTP Method: DELETE

      Parameters:

        partnerId

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

          Location: path

          Required: Yes

          Type: string

          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

        urlOrAppId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

        advertiserId

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

          Location: query

          Type: string

          Format: int64

      Parameter Order:

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

      Description: Deletes a site from a channel.

  • displayvideo.partners.channels.sites.bulkEdit

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

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

      HTTP Method: POST

      Parameters:

        partnerId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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.partners.channels.sites.replace

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

      Flat Path: v1/partners/{partnerId}/channels/{channelsId}/sites:replace

      HTTP Method: POST

      Parameters:

        partnerId

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

          Location: path

          Required: Yes

          Type: string

          Format: int64

        channelId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

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

      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.

  • displayvideo.partners.targetingTypes.assignedTargetingOptions.get

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

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

      HTTP Method: GET

      Parameters:

        partnerId

          Description: Required. The ID of the partner.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        assignedTargetingOptionId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

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

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

  • displayvideo.partners.targetingTypes.assignedTargetingOptions.list

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

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

      HTTP Method: GET

      Parameters:

        partnerId

          Description: Required. The ID of the partner.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        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

        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 `ListPartnerAssignedTargetingOptions` 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

        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 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.

          Location: query

          Type: string

      Parameter Order:

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

      Description: Lists the targeting options assigned to a partner.

  • displayvideo.partners.targetingTypes.assignedTargetingOptions.create

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

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

      HTTP Method: POST

      Parameters:

        partnerId

          Description: Required. The ID of the partner.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

      Parameter Order:

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

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

  • displayvideo.partners.targetingTypes.assignedTargetingOptions.delete

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

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

      HTTP Method: DELETE

      Parameters:

        partnerId

          Description: Required. The ID of the partner.

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

          Format: int64

        targetingType

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          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.
        • 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

        assignedTargetingOptionId

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

          Pattern: ^[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

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

      Description: Deletes an assigned targeting option from a partner.

  • displayvideo.sdfdownloadtasks.create

      Path: v1/sdfdownloadtasks

      Flat Path: v1/sdfdownloadtasks

      HTTP Method: POST

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

      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.

  • displayvideo.sdfdownloadtasks.operations.get

      Path: v1/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation resource.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: