Method: guaranteedOrders.editGuaranteedOrderReadAccessors

  • Display & Video 360 API v1 has been sunset.

  • This API endpoint allows you to edit the read access advertisers of a guaranteed order.

  • The request uses a POST method to the specified URL with a required guaranteedOrderId path parameter.

  • The request body allows you to specify a partner ID, whether read access is inherited, and lists of advertisers to add or remove.

  • The response body indicates whether read access is inherited and provides a list of advertiser IDs with read access.

Edits read advertisers of a guaranteed order.

HTTP request

POST https://displayvideo.googleapis.com/v1/guaranteedOrders/{guaranteedOrderId}:editGuaranteedOrderReadAccessors

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
guaranteedOrderId

string

Required. The ID of the guaranteed order to edit.

The ID is of the format {exchange}-{legacyGuaranteedOrderId}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "partnerId": string,
  "readAccessInherited": boolean,
  "addedAdvertisers": [
    string
  ],
  "removedAdvertisers": [
    string
  ]
}
Fields
partnerId

string (int64 format)

Required. The partner context in which the change is being made.
readAccessInherited

boolean

Whether to give all advertisers of the read/write accessor partner read access to the guaranteed order. Only applicable if readWritePartnerId is set in the guaranteed order.
addedAdvertisers[]

string (int64 format)

The advertisers to add as read accessors to the guaranteed order.
removedAdvertisers[]

string (int64 format)

The advertisers to remove as read accessors to the guaranteed order.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ]
}
Fields
readAccessInherited

boolean

Whether all advertisers of readWritePartnerId have read access to the guaranteed order.
readAdvertiserIds[]

string (int64 format)

The IDs of advertisers with read access to the guaranteed order.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.