Method: partners.list

Muestra una lista de los socios a los que puede acceder el usuario actual.

El orden se define con el parámetro orderBy.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v3/partners

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. Debe estar entre 1 y 200. Si no se especifica, se establecerá de forma predeterminada como 100.
pageToken

string

Un token que identifica una página de resultados que el servidor debe mostrar. Por lo general, este es el valor de nextPageToken que se muestra de la llamada anterior al método partners.list. Si no se especifica, se mostrará la primera página de resultados.
orderBy

string

Campo según el cual se ordenan los resultados. Los valores aceptables son:

  • displayName

El orden predeterminado es ascendente. Para especificar el orden descendente de un campo, se debe agregar un sufijo "desc" al nombre del campo. Por ejemplo, displayName desc.
filter

string

Permite filtrar por campos de socios.

Sintaxis admitida:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con los operadores lógicos AND o OR. Una secuencia de restricciones usa AND de forma implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • Todos los campos deben usar el operador EQUALS (=).

Campos admitidos:

  • entityStatus

Ejemplos:

  • Todos los socios activos: entityStatus="ENTITY_STATUS_ACTIVE"

La longitud de este campo no debe superar los 500 caracteres.

Consulta nuestra guía de solicitudes de LIST de filtro para obtener más información.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
Campos
partners[]

object (Partner)

Es la lista de socios.

Esta lista no aparecerá si está vacía.
nextPageToken

string

Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo pageToken en la llamada posterior al método partners.list para recuperar la siguiente página de resultados.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.