{ "opencollection": "1.0.0", "info": { "name": "Google Display & Video 360 API", "version": "v4" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Lists users that are accessible to the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/users", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing \"foo\": `displayName:\"foo\"` * The user with `email` containing \"bar\": `email:\"bar\"` * All users with standard user roles: `assignedUserRole.userRole=\"STANDARD\"` * All users with user roles for partner 123: `assignedUserRole.partnerId=\"123\"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId=\"123\"` * All users with partner level user roles: `entityType=\"PARTNER\"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId=\"123\"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>=\"2023-01-01T00:00:00Z\"` 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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method." }, { "info": { "name": "Creates a new user.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method." }, { "info": { "name": "Bulk edits user roles for a user.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/users/:usersId:bulkEditAssignedUserRoles", "params": [ { "name": "userId", "value": "", "type": "path", "description": "Required. The ID of the user to which the assigned user roles belong." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this meth" }, { "info": { "name": "Gets a user.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/users/:usersId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "Required. The ID of the user to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method." }, { "info": { "name": "Updates an existing user.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/users/:usersId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "Output only. The unique ID of the user. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method." }, { "info": { "name": "Deletes a user.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/users/:usersId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "Required. The ID of the user to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method." } ] }, { "info": { "name": "Guaranteed Orders", "type": "folder" }, "items": [ { "info": { "name": "Lists guaranteed orders that are accessible to the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/guaranteedOrders", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGuaranteedOrders` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the guaranteed order." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the guaranteed order." }, { "name": "orderBy", "value": "", "type": "query", "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`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Creates a new guaranteed order.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/guaranteedOrders", "params": [ { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that the request is being made within." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that the request is being made within." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new guaranteed order. Returns the newly created guaranteed order if successful." }, { "info": { "name": "Edits read advertisers of a guaranteed order.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/guaranteedOrders/:guaranteedOrdersId:editGuaranteedOrderReadAccessors", "params": [ { "name": "guaranteedOrderId", "value": "", "type": "path", "description": "Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Edits read advertisers of a guaranteed order." }, { "info": { "name": "Gets a guaranteed order.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/guaranteedOrders/:guaranteedOrdersId", "params": [ { "name": "guaranteedOrderId", "value": "", "type": "path", "description": "Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`" }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the guaranteed order." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the guaranteed order." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a guaranteed order." }, { "info": { "name": "Updates an existing guaranteed order.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/guaranteedOrders/:guaranteedOrdersId", "params": [ { "name": "guaranteedOrderId", "value": "", "type": "path", "description": "Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that the request is being made within." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that the request is being made within." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing guaranteed order. Returns the updated guaranteed order if successful." } ] }, { "info": { "name": "Media", "type": "folder" }, "items": [ { "info": { "name": "Uploads media.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/media/:mediaId", "params": [ { "name": "resourceName", "value": "", "type": "path", "description": "Name of the media that is being downloaded. See ReadRequest.resource_name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string." }, { "info": { "name": "Downloads media.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/download/:downloadId", "params": [ { "name": "resourceName", "value": "", "type": "path", "description": "Name of the media that is being downloaded. See ReadRequest.resource_name." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string." } ] }, { "info": { "name": "Custom Lists", "type": "folder" }, "items": [ { "info": { "name": "Gets a custom list.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customLists/:customListsId", "params": [ { "name": "customListId", "value": "", "type": "path", "description": "Required. The ID of the custom list to fetch." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the DV360 advertiser that has access to the fetched custom lists." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a custom list." }, { "info": { "name": "Lists custom lists.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customLists", "params": [ { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the DV360 advertiser that has access to the fetched custom lists." }, { "name": "orderBy", "value": "", "type": "query", "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`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists custom lists. The order is defined by the order_by parameter." } ] }, { "info": { "name": "First Party and Partner Audiences", "type": "folder" }, "items": [ { "info": { "name": "Updates the member list of a Customer Match audience.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences/:firstPartyAndPartnerAudiencesId:editCustomerMatchMembers", "params": [ { "name": "firstPartyAndPartnerAudienceId", "value": "", "type": "path", "description": "Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`" }, { "info": { "name": "Lists first party and partner audiences.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences", "params": [ { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the fetched first party and partner audiences." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the fetched first party and partner audiences." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (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`." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner 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 party and partner 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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists first party and partner audiences. The order is defined by the order_by parameter." }, { "info": { "name": "Creates a FirstPartyAndPartnerAudience.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences", "params": [ { "name": "advertiserId", "value": "", "type": "query", "description": "Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`" }, { "info": { "name": "Gets a first party or partner audience.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences/:firstPartyAndPartnerAudiencesId", "params": [ { "name": "firstPartyAndPartnerAudienceId", "value": "", "type": "path", "description": "Required. The ID of the first party and partner audience to fetch." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the fetched first party and partner audience." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the fetched first party and partner audience." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a first party or partner audience." }, { "info": { "name": "Updates an existing FirstPartyAndPartnerAudience.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences/:firstPartyAndPartnerAudiencesId", "params": [ { "name": "firstPartyAndPartnerAudienceId", "value": "", "type": "path", "description": "Identifier. The unique ID of the first party and partner audience. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`" }, { "name": "advertiserId", "value": "", "type": "query", "description": "Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`" } ] }, { "info": { "name": "Floodlight Groups", "type": "folder" }, "items": [ { "info": { "name": "Updates an existing Floodlight group.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/floodlightGroups/:floodlightGroupId", "params": [ { "name": "floodlightGroupId", "value": "", "type": "path", "description": "Output only. The unique ID of the Floodlight group. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." }, { "name": "partnerId", "value": "", "type": "query", "description": "Required. The partner context by which the Floodlight group is being accessed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing Floodlight group. Returns the updated Floodlight group if successful." }, { "info": { "name": "Gets a Floodlight group.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/floodlightGroups/:floodlightGroupsId", "params": [ { "name": "floodlightGroupId", "value": "", "type": "path", "description": "Required. The ID of the Floodlight group to fetch." }, { "name": "partnerId", "value": "", "type": "query", "description": "Required. The partner context by which the Floodlight group is being accessed." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a Floodlight group." }, { "info": { "name": "Gets a Floodlight activity.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/floodlightGroups/:floodlightGroupsId/floodlightActivities/:floodlightActivitiesId", "params": [ { "name": "floodlightGroupId", "value": "", "type": "path", "description": "Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs." }, { "name": "floodlightActivityId", "value": "", "type": "path", "description": "Required. The ID of the Floodlight activity to fetch." }, { "name": "partnerId", "value": "", "type": "query", "description": "Required. The ID of the partner through which the Floodlight activity is being accessed." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a Floodlight activity." }, { "info": { "name": "Lists Floodlight activities in a Floodlight group.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/floodlightGroups/:floodlightGroupsId/floodlightActivities", "params": [ { "name": "floodlightGroupId", "value": "", "type": "path", "description": "Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFloodlightActivities` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` 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`." }, { "name": "partnerId", "value": "", "type": "query", "description": "Required. The ID of the partner through which the Floodlight activities are being accessed." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists Floodlight activities in a Floodlight group." } ] }, { "info": { "name": "Targeting Types", "type": "folder" }, "items": [ { "info": { "name": "Searches for targeting options of a given type based on the given search terms.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/targetingTypes/:targetingTypesId/targetingOptions:search", "params": [ { "name": "targetingType", "value": "", "type": "path", "description": "Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for targeting options of a given type based on the given search terms." }, { "info": { "name": "Gets a single targeting option.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/targetingTypes/:targetingTypesId/targetingOptions/:targetingOptionsId", "params": [ { "name": "targetingType", "value": "", "type": "path", "description": "Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "targetingOptionId", "value": "", "type": "path", "description": "Required. The ID of the of targeting option to retrieve." }, { "name": "advertiserId", "value": "", "type": "query", "description": "Required. The Advertiser this request is being made in the context of." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a single targeting option." }, { "info": { "name": "Lists targeting options of a given type.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/targetingTypes/:targetingTypesId/targetingOptions", "params": [ { "name": "targetingType", "value": "", "type": "path", "description": "Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_COUNTRY\" OR geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_STATE\"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type=\"CARRIER_AND_ISP_TYPE_CARRIER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned." }, { "name": "advertiserId", "value": "", "type": "query", "description": "Required. The Advertiser this request is being made in the context of." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingOptionId desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists targeting options of a given type." } ] }, { "info": { "name": "SDF Download Tasks", "type": "folder" }, "items": [ { "info": { "name": "Creates an SDF Download Task.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/sdfdownloadtasks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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 `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that erro" }, { "info": { "name": "Gets the latest state of an asynchronous SDF download task operation.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/sdfdownloadtasks/operations/:operationsId", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds." } ] }, { "info": { "name": "Inventory Source Groups", "type": "folder" }, "items": [ { "info": { "name": "Updates an inventory source group.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups/:inventorySourceGroupId", "params": [ { "name": "inventorySourceGroupId", "value": "", "type": "path", "description": "Output only. The unique ID of the inventory source group. Assigned by the system." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the inventory source group. Only this partner has write access to this group." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an inventory source group. Returns the updated inventory source group if successful." }, { "info": { "name": "Lists inventory source groups that are accessible to the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups." }, { "name": "advertiserId", "value": "", "type": "query", "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." }, { "name": "orderBy", "value": "", "type": "query", "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`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter." }, { "info": { "name": "Creates a new inventory source group.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups", "params": [ { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group." }, { "name": "partnerId", "value": "", "type": "query", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new inventory source group. Returns the newly created inventory source group if successful." }, { "info": { "name": "Gets an inventory source group.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups/:inventorySourceGroupsId", "params": [ { "name": "inventorySourceGroupId", "value": "", "type": "path", "description": "Required. The ID of the inventory source group to fetch." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group." }, { "name": "advertiserId", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets an inventory source group." }, { "info": { "name": "Deletes an inventory source group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups/:inventorySourceGroupsId", "params": [ { "name": "inventorySourceGroupId", "value": "", "type": "path", "description": "Required. The ID of the inventory source group to delete." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the inventory source group. Only this partner has write access to this group." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an inventory source group." }, { "info": { "name": "Lists inventory sources assigned to an inventory source group.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups/:inventorySourceGroupsId/assignedInventorySources", "params": [ { "name": "inventorySourceGroupId", "value": "", "type": "path", "description": "Required. The ID of the inventory source group to which these assignments are assigned." }, { "name": "advertiserId", "value": "", "type": "query", "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." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "partnerId", "value": "", "type": "query", "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." }, { "name": "pageSize", "value": "", "type": "query", "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." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists inventory sources assigned to an inventory source group." }, { "info": { "name": "Creates an assignment between an inventory source and an inventory source group.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups/:inventorySourceGroupsId/assignedInventorySources", "params": [ { "name": "inventorySourceGroupId", "value": "", "type": "path", "description": "Required. The ID of the inventory source group to which the assignment will be assigned." }, { "name": "advertiserId", "value": "", "type": "query", "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." }, { "name": "partnerId", "value": "", "type": "query", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an assignment between an inventory source and an inventory source group." }, { "info": { "name": "Deletes the assignment between an inventory source and an inventory source group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups/:inventorySourceGroupsId/assignedInventorySources/:assignedInventorySourcesId", "params": [ { "name": "inventorySourceGroupId", "value": "", "type": "path", "description": "Required. The ID of the inventory source group to which this assignment is assigned." }, { "name": "assignedInventorySourceId", "value": "", "type": "path", "description": "Required. The ID of the assigned inventory source to delete." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source." }, { "name": "advertiserId", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes the assignment between an inventory source and an inventory source group." }, { "info": { "name": "Bulk edits multiple assignments between inventory sources and a single inventory source group.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/inventorySourceGroups/:inventorySourceGroupsId/assignedInventorySources:bulkEdit", "params": [ { "name": "inventorySourceGroupId", "value": "", "type": "path", "description": "Required. The ID of the inventory source group to which the assignments are assigned." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." } ] }, { "info": { "name": "Advertisers", "type": "folder" }, "items": [ { "info": { "name": "Gets an advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets an advertiser." }, { "info": { "name": "Updates an existing advertiser.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing advertiser. Returns the updated advertiser if successful." }, { "info": { "name": "Deletes an advertiser.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser we need to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Audits an advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId:audit", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to audit." }, { "name": "readMask", "value": "", "type": "query", "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" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists advertisers that are accessible to the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`." }, { "name": "partnerId", "value": "", "type": "query", "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." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `advertiserId` (default) * `displayName` * `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`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Creates a new advertiser.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors." }, { "info": { "name": "Edits targeting options under a single advertiser.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId:editAssignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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 ." }, { "info": { "name": "Lists assigned targeting options of an advertiser across targeting types.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId:listAssignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the line item belongs to." }, { "name": "pageSize", "value": "", "type": "query", "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." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists assigned targeting options of an advertiser across targeting types." }, { "info": { "name": "Uploads an asset.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/assets", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this asset belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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)." }, { "info": { "name": "Lists ad groups.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ad groups belongs to." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"AD_GROUP_FORMAT_IN_STREAM\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists ad groups." }, { "info": { "name": "Creates a new ad group.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the ad group belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups." }, { "info": { "name": "Bulk edits targeting options for multiple ad groups.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups:bulkEditAssignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ad groups belong to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups." }, { "info": { "name": "Gets an ad group.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this ad group belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "Required. The ID of the ad group to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets an ad group." }, { "info": { "name": "Updates an existing ad group.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the ad group belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "Output only. The unique ID of the ad group. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups." }, { "info": { "name": "Deletes a AdGroup.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this ad group belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "Required. The ID of the ad group to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups." }, { "info": { "name": "Lists assigned targeting options for multiple ad groups across targeting types.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups:bulkListAssignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the line items belongs to." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`." }, { "name": "adGroupIds", "value": "", "type": "query", "description": "Required. The IDs of the ad groups to list assigned targeting options for." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType=\"TARGETING_TYPE_YOUTUBE_VIDEO\" OR targetingType=\"TARGETING_TYPE_YOUTUBE_CHANNEL\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included." }, { "info": { "name": "Lists the targeting options assigned to an ad group.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId/targetingTypes/:targetingTypesId/assignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ad group belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "Required. The ID of the ad group to list assigned targeting options for." }, { "name": "targetingType", "value": "", "type": "path", "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included." }, { "info": { "name": "Assigns a targeting option to an ad group.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId/targetingTypes/:targetingTypesId/assignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ad group belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "Required. The ID of the ad group the assigned targeting option will belong to." }, { "name": "targetingType", "value": "", "type": "path", "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups." }, { "info": { "name": "Gets a single targeting option assigned to an ad group.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId/targetingTypes/:targetingTypesId/assignedTargetingOptions/:assignedTargetingOptionsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ad group belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "Required. The ID of the ad group the assigned targeting option belongs to." }, { "name": "targetingType", "value": "", "type": "path", "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "assignedTargetingOptionId", "value": "", "type": "path", "description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included." }, { "info": { "name": "Deletes an assigned targeting option from an ad group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId/targetingTypes/:targetingTypesId/assignedTargetingOptions/:assignedTargetingOptionsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ad group belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "Required. The ID of the ad group the assigned targeting option belongs to." }, { "name": "targetingType", "value": "", "type": "path", "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "assignedTargetingOptionId", "value": "", "type": "path", "description": "Required. The ID of the assigned targeting option to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`." }, { "info": { "name": "Lists the YouTube asset associations linked to the given resource.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId/youtubeAssetTypes/:youtubeAssetTypesId/youtubeAssetAssociations", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser that the linked entity belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "The ID of an ad group." }, { "name": "youtubeAssetType", "value": "", "type": "path", "description": "Required. The type of YouTube asset being associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`." }, { "name": "linkedEntity.lineItemId", "value": "", "type": "query", "description": "The ID of a line item." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. 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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the YouTube asset associations linked to the given resource." }, { "info": { "name": "Creates a new association between the identified resource and a YouTube asset.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId/youtubeAssetTypes/:youtubeAssetTypesId/youtubeAssetAssociations", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser that the linked entity belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "The ID of an ad group." }, { "name": "youtubeAssetType", "value": "", "type": "path", "description": "Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset." }, { "name": "linkedEntity.lineItemId", "value": "", "type": "query", "description": "The ID of a line item." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users." }, { "info": { "name": "Deletes an existing association between the identified resource and a YouTube asset.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroups/:adGroupsId/youtubeAssetTypes/:youtubeAssetTypesId/youtubeAssetAssociations/:youtubeAssetAssociationsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser that the linked entity belongs to." }, { "name": "adGroupId", "value": "", "type": "path", "description": "The ID of an ad group." }, { "name": "youtubeAssetType", "value": "", "type": "path", "description": "Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset." }, { "name": "youtubeAssetAssociationId", "value": "", "type": "path", "description": "Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked." }, { "name": "linkedEntity.lineItemId", "value": "", "type": "query", "description": "The ID of a line item." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users." }, { "info": { "name": "Lists line items in an advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to list line items for." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Creates a new line item.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the line item belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists assigned targeting options for multiple line items across targeting types.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems:bulkListAssignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the line items belongs to." }, { "name": "pageSize", "value": "", "type": "query", "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." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR targetingType=\"TARGETING_TYPE_CHANNEL\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`." }, { "name": "lineItemIds", "value": "", "type": "query", "description": "Required. The IDs of the line items to list assigned targeting options for." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists assigned targeting options for multiple line items across targeting types." }, { "info": { "name": "Gets a line item.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this line item belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "Required. The ID of the line item to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a line item." }, { "info": { "name": "Updates an existing line item.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the line item belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "Output only. The unique ID of the line item. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/" }, { "info": { "name": "Deletes a line item.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser this line item belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "The ID of the line item to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Duplicates a line item.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId:duplicate", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this line item belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "Required. The ID of the line item to duplicate." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors." }, { "info": { "name": "Updates multiple line items.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems:bulkUpdate", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this line item belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API." }, { "info": { "name": "Bulk edits targeting options under multiple line items.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems:bulkEditAssignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the line items belong to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargeti" }, { "info": { "name": "Lists the targeting options assigned to a line item.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId/targetingTypes/:targetingTypesId/assignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the line item belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "Required. The ID of the line item to list assigned targeting options for." }, { "name": "targetingType", "value": "", "type": "path", "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) Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageSize", "value": "", "type": "query", "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." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the targeting options assigned to a line item." }, { "info": { "name": "Assigns a targeting option to a line item.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId/targetingTypes/:targetingTypesId/assignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the line item belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "Required. The ID of the line item the assigned targeting option will belong to." }, { "name": "targetingType", "value": "", "type": "path", "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` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Gets a single targeting option assigned to a line item.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId/targetingTypes/:targetingTypesId/assignedTargetingOptions/:assignedTargetingOptionsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the line item belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "Required. The ID of the line item the assigned targeting option belongs to." }, { "name": "targetingType", "value": "", "type": "path", "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) Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "assignedTargetingOptionId", "value": "", "type": "path", "description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a single targeting option assigned to a line item." }, { "info": { "name": "Deletes an assigned targeting option from a line item.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId/targetingTypes/:targetingTypesId/assignedTargetingOptions/:assignedTargetingOptionsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the line item belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "Required. The ID of the line item the assigned targeting option belongs to." }, { "name": "targetingType", "value": "", "type": "path", "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` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "assignedTargetingOptionId", "value": "", "type": "path", "description": "Required. The ID of the assigned targeting option to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists the YouTube asset associations linked to the given resource.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId/youtubeAssetTypes/:youtubeAssetTypesId/youtubeAssetAssociations", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser that the linked entity belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "The ID of a line item." }, { "name": "youtubeAssetType", "value": "", "type": "path", "description": "Required. The type of YouTube asset being associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. 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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`." }, { "name": "linkedEntity.adGroupId", "value": "", "type": "query", "description": "The ID of an ad group." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the YouTube asset associations linked to the given resource." }, { "info": { "name": "Creates a new association between the identified resource and a YouTube asset.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId/youtubeAssetTypes/:youtubeAssetTypesId/youtubeAssetAssociations", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser that the linked entity belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "The ID of a line item." }, { "name": "youtubeAssetType", "value": "", "type": "path", "description": "Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset." }, { "name": "linkedEntity.adGroupId", "value": "", "type": "query", "description": "The ID of an ad group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users." }, { "info": { "name": "Deletes an existing association between the identified resource and a YouTube asset.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/lineItems/:lineItemsId/youtubeAssetTypes/:youtubeAssetTypesId/youtubeAssetAssociations/:youtubeAssetAssociationsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser that the linked entity belongs to." }, { "name": "lineItemId", "value": "", "type": "path", "description": "The ID of a line item." }, { "name": "youtubeAssetType", "value": "", "type": "path", "description": "Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset." }, { "name": "youtubeAssetAssociationId", "value": "", "type": "path", "description": "Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked." }, { "name": "linkedEntity.adGroupId", "value": "", "type": "query", "description": "The ID of an ad group." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users." }, { "info": { "name": "Updates a channel.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/channels/:channelId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the created channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Output only. The unique ID of the channel. Assigned by the system." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the created channel." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a channel. Returns the updated channel if successful." }, { "info": { "name": "Gets a channel for a partner or advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/channels/:channelsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the fetched channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the channel to fetch." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the fetched channel." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a channel for a partner or advertiser." }, { "info": { "name": "Lists channels for a partner or advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/channels", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the channels." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the channels." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists channels for a partner or advertiser." }, { "info": { "name": "Creates a new channel.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/channels", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the created channel." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the created channel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new channel. Returns the newly created channel if successful." }, { "info": { "name": "Lists sites in a channel.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/channels/:channelsId/sites", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel to which the requested sites belong." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the parent channel." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists sites in a channel." }, { "info": { "name": "Creates a site in a channel.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/channels/:channelsId/sites", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel in which the site will be created." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the parent channel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a site in a channel." }, { "info": { "name": "Replaces all of the sites under a single channel.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/channels/:channelsId/sites:replace", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel whose sites will be replaced." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors." }, { "info": { "name": "Deletes a site from a channel.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/channels/:channelsId/sites/:sitesId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel to which the site belongs." }, { "name": "urlOrAppId", "value": "", "type": "path", "description": "Required. The URL or app ID of the site to delete." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the parent channel." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a site from a channel." }, { "info": { "name": "Bulk edits sites under a single channel.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/channels/:channelsId/sites:bulkEdit", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel to which the sites belong." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists creatives in an advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/creatives", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to list creatives for." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType=\"CREATIVE_TYPE_NATIVE\"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus=\"ENTITY_STATUS_ACTIVE\" AND (dimensions=\"300x400\" OR dimensions=\"50x100\")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic=\"true\" AND minDuration=\"5.2s\" AND (exchangeReviewStatus=\"EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED\" OR exchangeReviewStatus=\"EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED\")` * All video creatives that are associated with line item ID 1 or 2: `creativeType=\"CREATIVE_TYPE_VIDEO\" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned." }, { "name": "orderBy", "value": "", "type": "query", "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`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Creates a new creative.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/creatives", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the creative belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Gets a creative.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/creatives/:creativesId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this creative belongs to." }, { "name": "creativeId", "value": "", "type": "path", "description": "Required. The ID of the creative to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a creative." }, { "info": { "name": "Updates an existing creative.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/creatives/:creativesId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the creative belongs to." }, { "name": "creativeId", "value": "", "type": "path", "description": "Output only. The unique ID of the creative. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Deletes a creative.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/creatives/:creativesId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser this creative belongs to." }, { "name": "creativeId", "value": "", "type": "path", "description": "The ID of the creative to be deleted." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists ad group ads.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroupAds", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ads belong to." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId=\"1234\"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupId=\"12345\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists ad group ads." }, { "info": { "name": "Creates an ad group ad.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroupAds", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the ad belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an ad group ad. This method is only supported for Demand Gen ads." }, { "info": { "name": "Gets an ad group ad.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroupAds/:adGroupAdsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this ad group ad belongs to." }, { "name": "adGroupAdId", "value": "", "type": "path", "description": "Required. The ID of the ad to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets an ad group ad." }, { "info": { "name": "Updates an ad group ad.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroupAds/:adGroupAdsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the ad belongs to." }, { "name": "adGroupAdId", "value": "", "type": "path", "description": "Output only. The unique ID of the ad. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an ad group ad. This method is only supported for Demand Gen ads." }, { "info": { "name": "Deletes an ad group ad.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adGroupAds/:adGroupAdsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ad belongs to." }, { "name": "adGroupAdId", "value": "", "type": "path", "description": "Required. The ID of the ad to delete. Only Demand Gen ads are supported." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an ad group ad. This method is only supported for Demand Gen ads." }, { "info": { "name": "Gets an insertion order.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/insertionOrders/:insertionOrdersId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this insertion order belongs to." }, { "name": "insertionOrderId", "value": "", "type": "path", "description": "Required. The ID of the insertion order to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist." }, { "info": { "name": "Updates an existing insertion order.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/insertionOrders/:insertionOrdersId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the insertion order belongs to." }, { "name": "insertionOrderId", "value": "", "type": "path", "description": "Output only. The unique ID of the insertion order. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing insertion order. Returns the updated insertion order if successful." }, { "info": { "name": "Deletes an insertion order.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/insertionOrders/:insertionOrdersId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser this insertion order belongs to." }, { "name": "insertionOrderId", "value": "", "type": "path", "description": "The ID of the insertion order to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists insertion orders in an advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/insertionOrders", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to list insertion orders for." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * \"updateTime\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`." }, { "name": "pageSize", "value": "", "type": "query", "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." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Creates a new insertion order.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/insertionOrders", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the insertion order belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new insertion order. Returns the newly created insertion order if successful." }, { "info": { "name": "Retrieves first and third party user lists available for forecasting.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/reachForecast:retrievePlannableUserLists", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to retrieve plannable user lists for." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Allows filtering by plannable user list properties. 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 `displayName` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `plannableStatus` * `displayName` * `userListType` * `name` Examples: * All plannable user lists: `plannableStatus=\"PLANNABLE\"` * Plannable user lists with display name containing \"Shopping\": `plannableStatus=\"PLANNABLE\" AND displayName:\"Shopping\"` * First party user lists: `userListType=\"FIRST_PARTY\"` 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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `RetrievePlannableUserLists` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves first and third party user lists available for forecasting. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users." }, { "info": { "name": "Generates a reach forecast for a given advertiser and targeting configuration.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/reachForecast:generateReachForecast", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser that will run the planned campaign." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Generates a reach forecast for a given advertiser and targeting configuration. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users." }, { "info": { "name": "Retrieves the list of countries where reach forecasting is supported.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/reachForecast:retrievePlannableLocations", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to list plannable locations for." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the list of countries where reach forecasting is supported. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users." }, { "info": { "name": "Retrieves the list of products that can be planned for a location.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/reachForecast:retrievePlannableProducts", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to list plannable products for." }, { "name": "plannableLocationId", "value": "", "type": "query", "description": "Required. The ID of the plannable location." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the list of products that can be planned for a location. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users." }, { "info": { "name": "Retrieves Google Audiences (User Interests) available for forecasting.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/reachForecast:retrievePlannableUserInterests", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to list plannable user interests for." }, { "name": "productCategory", "value": "", "type": "query", "description": "Required. The product category to retrieve plannable user interests for. Allowed values — `PLANNABLE_PRODUCT_CATEGORY_UNSPECIFIED`: Not specified.; `YOUTUBE`: YouTube.; `OPEN_AUCTION`: Open Auction." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves Google Audiences (User Interests) available for forecasting. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users." }, { "info": { "name": "Lists campaigns in an advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/campaigns", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser to list campaigns for." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Creates a new campaign.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/campaigns", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the campaign belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new campaign. Returns the newly created campaign if successful." }, { "info": { "name": "Gets a campaign.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/campaigns/:campaignsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this campaign belongs to." }, { "name": "campaignId", "value": "", "type": "path", "description": "Required. The ID of the campaign to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a campaign." }, { "info": { "name": "Updates an existing campaign.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/campaigns/:campaignsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Output only. The unique ID of the advertiser the campaign belongs to." }, { "name": "campaignId", "value": "", "type": "path", "description": "Output only. The unique ID of the campaign. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing campaign. Returns the updated campaign if successful." }, { "info": { "name": "Permanently deletes a campaign.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/campaigns/:campaignsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The ID of the advertiser this campaign belongs to." }, { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the campaign we need to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors." }, { "info": { "name": "Gets a location list.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/locationLists/:locationListsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the fetched location list belongs." }, { "name": "locationListId", "value": "", "type": "path", "description": "Required. The ID of the location list to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a location list." }, { "info": { "name": "Lists location lists based on a given advertiser id.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/locationLists", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"` * All proximity location list: `locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "orderBy", "value": "", "type": "query", "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`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists location lists based on a given advertiser id." }, { "info": { "name": "Creates a new location list.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/locationLists", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the location list belongs." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new location list. Returns the newly created location list if successful." }, { "info": { "name": "Updates a location list.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/locationLists/:locationListId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the location lists belongs." }, { "name": "locationListId", "value": "", "type": "path", "description": "Output only. The unique ID of the location list. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a location list. Returns the updated location list if successful." }, { "info": { "name": "Lists locations assigned to a location list.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/locationLists/:locationListId/assignedLocations", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the location list belongs." }, { "name": "locationListId", "value": "", "type": "path", "description": "Required. The ID of the location list to which these assignments are assigned." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists locations assigned to a location list." }, { "info": { "name": "Creates an assignment between a location and a location list.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/locationLists/:locationListId/assignedLocations", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the location list belongs." }, { "name": "locationListId", "value": "", "type": "path", "description": "Required. The ID of the location list for which the assignment will be created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an assignment between a location and a location list." }, { "info": { "name": "Deletes the assignment between a location and a location list.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/locationLists/:locationListId/assignedLocations/:assignedLocationsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the location list belongs." }, { "name": "locationListId", "value": "", "type": "path", "description": "Required. The ID of the location list to which this assignment is assigned." }, { "name": "assignedLocationId", "value": "", "type": "path", "description": "Required. The ID of the assigned location to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes the assignment between a location and a location list." }, { "info": { "name": "Bulk edits multiple assignments between locations and a single location list.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/locationLists/:locationListsId/assignedLocations:bulkEdit", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the location list belongs." }, { "name": "locationListId", "value": "", "type": "path", "description": "Required. The ID of the location list to which these assignments are assigned." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Gets a single targeting option assigned to an advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/targetingTypes/:targetingTypesId/assignedTargetingOptions/:assignedTargetingOptionsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser." }, { "name": "targetingType", "value": "", "type": "path", "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` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "assignedTargetingOptionId", "value": "", "type": "path", "description": "Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a single targeting option assigned to an advertiser." }, { "info": { "name": "Deletes an assigned targeting option from an advertiser.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/targetingTypes/:targetingTypesId/assignedTargetingOptions/:assignedTargetingOptionsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser." }, { "name": "targetingType", "value": "", "type": "path", "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_KEYWORD` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "assignedTargetingOptionId", "value": "", "type": "path", "description": "Required. The ID of the assigned targeting option to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an assigned targeting option from an advertiser." }, { "info": { "name": "Lists the targeting options assigned to an advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/targetingTypes/:targetingTypesId/assignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser." }, { "name": "targetingType", "value": "", "type": "path", "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` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `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." }, { "name": "pageSize", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the targeting options assigned to an advertiser." }, { "info": { "name": "Assigns a targeting option to an advertiser.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/targetingTypes/:targetingTypesId/assignedTargetingOptions", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser." }, { "name": "targetingType", "value": "", "type": "path", "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_KEYWORD` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful." }, { "info": { "name": "Lists ad assets under an advertiser ID.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adAssets", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser the ad assets belong to." }, { "name": "orderBy", "value": "", "type": "query", "description": "Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (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: `adAssetId desc`." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`." }, { "info": { "name": "Creates an ad asset.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adAssets", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this ad asset belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`." }, { "info": { "name": "Gets an ad asset.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adAssets/:adAssetsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this ad asset belongs to." }, { "name": "adAssetId", "value": "", "type": "path", "description": "Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`." }, { "info": { "name": "Updates an ad asset.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adAssets/:adAssetsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this ad asset belongs to." }, { "name": "adAssetId", "value": "", "type": "path", "description": "Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an ad asset. Returns the updated ad asset if successful. Supports updating assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` and `AD_ASSET_TYPE_IMAGE`. Only the AdAsset.synthetic_content_attestation_status field is mutable." }, { "info": { "name": "Uploads and creates an ad asset.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adAssets:uploadAdAsset", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser this ad asset belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`." }, { "info": { "name": "Creates multiple ad assets in a single request.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/adAssets:bulkCreate", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser these ad assets belong to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`." }, { "info": { "name": "Lists invoices posted for an advertiser in a given month.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/invoices", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to list invoices for." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "loiSapinInvoiceType", "value": "", "type": "query", "description": "Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. Allowed values — `LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED`: Value is not specified.; `LOI_SAPIN_INVOICE_TYPE_MEDIA`: Invoices with Media cost.; `LOI_SAPIN_INVOICE_TYPE_PLATFORM`: Invoices with Platform fee." }, { "name": "issueMonth", "value": "", "type": "query", "description": "The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Retrieves the invoice currency used by an advertiser in a given month.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/invoices:lookupInvoiceCurrency", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the advertiser to lookup currency for." }, { "name": "invoiceMonth", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the invoice currency used by an advertiser in a given month." }, { "info": { "name": "Lists negative keyword lists based on a given advertiser id.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/negativeKeywordLists", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists negative keyword lists based on a given advertiser id." }, { "info": { "name": "Creates a new negative keyword list.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/negativeKeywordLists", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the negative keyword list will belong." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new negative keyword list. Returns the newly created negative keyword list if successful." }, { "info": { "name": "Updates a negative keyword list.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/negativeKeywordLists/:negativeKeywordListId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs." }, { "name": "negativeKeywordListId", "value": "", "type": "path", "description": "Output only. The unique ID of the negative keyword list. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a negative keyword list. Returns the updated negative keyword list if successful." }, { "info": { "name": "Gets a negative keyword list given an advertiser ID and a negative keyword list ID.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/negativeKeywordLists/:negativeKeywordListsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs." }, { "name": "negativeKeywordListId", "value": "", "type": "path", "description": "Required. The ID of the negative keyword list to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a negative keyword list given an advertiser ID and a negative keyword list ID." }, { "info": { "name": "Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/negativeKeywordLists/:negativeKeywordListsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs." }, { "name": "negativeKeywordListId", "value": "", "type": "path", "description": "Required. The ID of the negative keyword list to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a negative keyword list given an advertiser ID and a negative keyword list ID." }, { "info": { "name": "Creates a negative keyword in a negative keyword list.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/negativeKeywordLists/:negativeKeywordListsId/negativeKeywords", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs." }, { "name": "negativeKeywordListId", "value": "", "type": "path", "description": "Required. The ID of the parent negative keyword list in which the negative keyword will be created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a negative keyword in a negative keyword list." }, { "info": { "name": "Replaces all negative keywords in a single negative keyword list.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/negativeKeywordLists/:negativeKeywordListsId/negativeKeywords:replace", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs." }, { "name": "negativeKeywordListId", "value": "", "type": "path", "description": "Required. The ID of the parent negative keyword list to which the negative keywords belong." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Deletes a negative keyword from a negative keyword list.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/negativeKeywordLists/:negativeKeywordListsId/negativeKeywords/:negativeKeywordsId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs." }, { "name": "negativeKeywordListId", "value": "", "type": "path", "description": "Required. The ID of the parent negative keyword list to which the negative keyword belongs." }, { "name": "keywordValue", "value": "", "type": "path", "description": "Required. The keyword value of the negative keyword to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a negative keyword from a negative keyword list." }, { "info": { "name": "Bulk edits negative keywords in a single negative keyword list.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertiserId/negativeKeywordLists/:negativeKeywordListsId/negativeKeywords:bulkEdit", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs." }, { "name": "negativeKeywordListId", "value": "", "type": "path", "description": "Required. The ID of the parent negative keyword list to which the negative keywords belong." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists negative keywords in a negative keyword list.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/advertisers/:advertisersId/negativeKeywordLists/:negativeKeywordListsId/negativeKeywords", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs." }, { "name": "negativeKeywordListId", "value": "", "type": "path", "description": "Required. The ID of the parent negative keyword list to which the requested negative keywords belong." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains \"google\": `keywordValue : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists negative keywords in a negative keyword list." } ] }, { "info": { "name": "Google Audiences", "type": "folder" }, "items": [ { "info": { "name": "Gets a Google audience.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/googleAudiences/:googleAudiencesId", "params": [ { "name": "googleAudienceId", "value": "", "type": "path", "description": "Required. The ID of the Google audience to fetch." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the fetched Google audience." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the fetched Google audience." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a Google audience." }, { "info": { "name": "Lists Google audiences.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/googleAudiences", "params": [ { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the fetched Google audiences." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the fetched Google audiences." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists Google audiences. The order is defined by the order_by parameter." } ] }, { "info": { "name": "Partners", "type": "folder" }, "items": [ { "info": { "name": "Gets a partner.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "Required. The ID of the partner to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a partner." }, { "info": { "name": "Lists partners that are accessible to the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/partners", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists partners that are accessible to the current user. The order is defined by the order_by parameter." }, { "info": { "name": "Edits targeting options under a single partner.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId:editAssignedTargetingOptions", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "Required. The ID of the partner." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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 ." }, { "info": { "name": "Lists channels for a partner or advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/channels", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the channels." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the channels." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists channels for a partner or advertiser." }, { "info": { "name": "Creates a new channel.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/channels", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the created channel." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the created channel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new channel. Returns the newly created channel if successful." }, { "info": { "name": "Updates a channel.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/channels/:channelId", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the created channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Output only. The unique ID of the channel. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the created channel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a channel. Returns the updated channel if successful." }, { "info": { "name": "Gets a channel for a partner or advertiser.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/channels/:channelsId", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the fetched channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the channel to fetch." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the fetched channel." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a channel for a partner or advertiser." }, { "info": { "name": "Creates a site in a channel.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/partners/:partnerId/channels/:channelsId/sites", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel in which the site will be created." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent channel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a site in a channel." }, { "info": { "name": "Replaces all of the sites under a single channel.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/partners/:partnerId/channels/:channelsId/sites:replace", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel whose sites will be replaced." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors." }, { "info": { "name": "Deletes a site from a channel.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/partners/:partnerId/channels/:channelsId/sites/:sitesId", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel to which the site belongs." }, { "name": "urlOrAppId", "value": "", "type": "path", "description": "Required. The URL or app ID of the site to delete." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent channel." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a site from a channel." }, { "info": { "name": "Bulk edits sites under a single channel.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/partners/:partnerId/channels/:channelsId/sites:bulkEdit", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel to which the sites belong." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists sites in a channel.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/channels/:channelsId/sites", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "The ID of the partner that owns the parent channel." }, { "name": "channelId", "value": "", "type": "path", "description": "Required. The ID of the parent channel to which the requested sites belong." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent channel." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists sites in a channel." }, { "info": { "name": "Lists the targeting options assigned to a partner.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/targetingTypes/:targetingTypesId/assignedTargetingOptions", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "Required. The ID of the partner." }, { "name": "targetingType", "value": "", "type": "path", "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "filter", "value": "", "type": "query", "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` 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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the targeting options assigned to a partner." }, { "info": { "name": "Assigns a targeting option to a partner.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/targetingTypes/:targetingTypesId/assignedTargetingOptions", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "Required. The ID of the partner." }, { "name": "targetingType", "value": "", "type": "path", "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Assigns a targeting option to a partner. Returns the assigned targeting option if successful." }, { "info": { "name": "Gets a single targeting option assigned to a partner.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/targetingTypes/:targetingTypesId/assignedTargetingOptions/:assignedTargetingOptionsId", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "Required. The ID of the partner." }, { "name": "targetingType", "value": "", "type": "path", "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "assignedTargetingOptionId", "value": "", "type": "path", "description": "Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a single targeting option assigned to a partner." }, { "info": { "name": "Deletes an assigned targeting option from a partner.", "type": "http" }, "http": { "method": "DELETE", "url": "https://displayvideo.googleapis.com/v4/partners/:partnersId/targetingTypes/:targetingTypesId/assignedTargetingOptions/:assignedTargetingOptionsId", "params": [ { "name": "partnerId", "value": "", "type": "path", "description": "Required. The ID of the partner." }, { "name": "targetingType", "value": "", "type": "path", "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: 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.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack." }, { "name": "assignedTargetingOptionId", "value": "", "type": "path", "description": "Required. The ID of the assigned targeting option to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an assigned targeting option from a partner." } ] }, { "info": { "name": "Inventory Sources", "type": "folder" }, "items": [ { "info": { "name": "Edits read/write accessors of an inventory source.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/inventorySources/:inventorySourcesId:editInventorySourceReadWriteAccessors", "params": [ { "name": "inventorySourceId", "value": "", "type": "path", "description": "Required. The ID of inventory source to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source." }, { "info": { "name": "Lists inventory sources that are accessible to the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/inventorySources", "params": [ { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the inventory source." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the inventory source." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Creates a new inventory source.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/inventorySources", "params": [ { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that the request is being made within." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that the request is being made within." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new inventory source. Returns the newly created inventory source if successful." }, { "info": { "name": "Gets an inventory source.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/inventorySources/:inventorySourcesId", "params": [ { "name": "inventorySourceId", "value": "", "type": "path", "description": "Required. The ID of the inventory source to fetch." }, { "name": "advertiserId", "value": "", "type": "query", "description": "Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser." }, { "name": "partnerId", "value": "", "type": "query", "description": "Required. The ID of the DV360 partner to which the fetched inventory source is permissioned." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets an inventory source." }, { "info": { "name": "Updates an existing inventory source.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/inventorySources/:inventorySourcesId", "params": [ { "name": "inventorySourceId", "value": "", "type": "path", "description": "Output only. The unique ID of the inventory source. Assigned by the system." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that the request is being made within." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that the request is being made within." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing inventory source. Returns the updated inventory source if successful." } ] }, { "info": { "name": "SDF Upload Tasks", "type": "folder" }, "items": [ { "info": { "name": "Gets the latest state of an asynchronous SDF download task operation.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/sdfuploadtasks/operations/:operationsId", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds." } ] }, { "info": { "name": "Combined Audiences", "type": "folder" }, "items": [ { "info": { "name": "Gets a combined audience.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/combinedAudiences/:combinedAudiencesId", "params": [ { "name": "combinedAudienceId", "value": "", "type": "path", "description": "Required. The ID of the combined audience to fetch." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the fetched combined audience." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the fetched combined audience." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a combined audience." }, { "info": { "name": "Lists combined audiences.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/combinedAudiences", "params": [ { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that has access to the fetched combined audiences." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that has access to the fetched combined audiences." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists combined audiences. The order is defined by the order_by parameter." } ] }, { "info": { "name": "Custom Bidding Algorithms", "type": "folder" }, "items": [ { "info": { "name": "Creates a rules reference object for an AlgorithmRules file.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId:uploadRules", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm that owns the rules resource." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent custom bidding algorithm." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the parent custom bidding algorithm." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource." }, { "info": { "name": "Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned." }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the DV360 partner that has access to the custom bidding algorithm." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the DV360 advertiser that has access to the custom bidding algorithm." }, { "name": "orderBy", "value": "", "type": "query", "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`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Creates a new custom bidding algorithm.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful." }, { "info": { "name": "Creates a custom bidding script reference object for a script file.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId:uploadScript", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm owns the script." }, { "name": "partnerId", "value": "", "type": "query", "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." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent custom bidding algorithm." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Gets a custom bidding algorithm.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm to fetch." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the DV360 partner that has access to the custom bidding algorithm." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the DV360 partner that has access to the custom bidding algorithm." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a custom bidding algorithm." }, { "info": { "name": "Updates an existing custom bidding algorithm.", "type": "http" }, "http": { "method": "PATCH", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Output only. The unique ID of the custom bidding algorithm. Assigned by the system." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The mask to control which fields to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error." }, { "info": { "name": "Lists rules resources that belong to the given algorithm.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId/rules", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm that owns the rules resource." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the parent custom bidding algorithm." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent custom bidding algorithm." }, { "name": "orderBy", "value": "", "type": "query", "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`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter." }, { "info": { "name": "Creates a new rules resource.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId/rules", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm that owns the rules resource." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent custom bidding algorithm." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error." }, { "info": { "name": "Retrieves a rules resource.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId/rules/:rulesId", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm that owns the rules resource." }, { "name": "customBiddingAlgorithmRulesId", "value": "", "type": "path", "description": "Required. The ID of the rules resource to fetch." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent custom bidding algorithm." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner that owns the parent custom bidding algorithm." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a rules resource." }, { "info": { "name": "Lists custom bidding scripts that belong to the given algorithm.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId/scripts", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm owns the script." }, { "name": "pageSize", "value": "", "type": "query", "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified." }, { "name": "pageToken", "value": "", "type": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent custom bidding algorithm." }, { "name": "orderBy", "value": "", "type": "query", "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`." }, { "name": "partnerId", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter." }, { "info": { "name": "Creates a new custom bidding script.", "type": "http" }, "http": { "method": "POST", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId/scripts", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm that owns the script." }, { "name": "partnerId", "value": "", "type": "query", "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." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent custom bidding algorithm." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error." }, { "info": { "name": "Gets a custom bidding script.", "type": "http" }, "http": { "method": "GET", "url": "https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/:customBiddingAlgorithmsId/scripts/:scriptsId", "params": [ { "name": "customBiddingAlgorithmId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding algorithm owns the script." }, { "name": "customBiddingScriptId", "value": "", "type": "path", "description": "Required. The ID of the custom bidding script to fetch." }, { "name": "advertiserId", "value": "", "type": "query", "description": "The ID of the advertiser that owns the parent custom bidding algorithm." }, { "name": "partnerId", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a custom bidding script." } ] } ], "bundled": true }