Method: advertisers.campaigns.targetingTypes.assignedTargetingOptions.list

Enumera las opciones de segmentación asignadas a una campaña para un tipo de segmentación especificado.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions

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

Parámetros de ruta

Parámetros
advertiserId

string (int64 format)

Obligatorio. Es el ID del anunciante al que pertenece la campaña.

campaignId

string (int64 format)

Obligatorio. Es el ID de la campaña para la que se enumerarán las opciones de segmentación asignadas.

targetingType

enum (TargetingType)

Obligatorio. Identifica el tipo de opciones de segmentación asignadas que se incluirán en la lista.

Tipos de segmentación admitidos:

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. La hora debe configurarse entre 1 y 5000. Si no se especifica, se usará el valor predeterminado 100. Devuelve el código de error INVALID_ARGUMENT si se especifica un valor no válido.

pageToken

string

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

orderBy

string

Es el campo según el cual se ordenará la lista. Los valores aceptables son:

  • assignedTargetingOptionId (predeterminada)

El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, se debe agregar el sufijo "desc" al nombre del campo. Ejemplo: assignedTargetingOptionId desc.

filter

string

Permite filtrar por los campos de opciones de segmentación asignados.

Sintaxis admitida:

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

Campos admitidos:

  • assignedTargetingOptionId
  • inheritance

Ejemplos:

  • AssignedTargetingOption recursos con ID 1 o 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"
  • Recursos AssignedTargetingOption con estado de herencia NOT_INHERITED o INHERITED_FROM_PARTNER inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"

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

Para obtener más información, consulta nuestra guía sobre las solicitudes de filtro LIST.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para assignedTargetingOptions.list.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

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

object (AssignedTargetingOption)

Es la lista de opciones de segmentación asignadas.

Esta lista no estará presente si está vacía.

nextPageToken

string

Es un token que identifica la siguiente página de resultados. Este valor se debe especificar como pageToken en un ListCampaignAssignedTargetingOptionsRequest posterior para recuperar la siguiente página de resultados. Este token no estará presente si no hay más assignedTargetingOptions para devolver.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.