Ad Manager API는 일반적으로 List 메서드에서 데이터 모음을 제공합니다. 컬렉션의 크기는 임의로 지정할 수 있으며 API 응답에서 페이지로 나뉩니다.
기본사항
컬렉션의 요청 메시지는 반환할 최대 결과 수를 지정하는 선택적 정수 pageSize 필드를 정의합니다.
pageSize 매개변수를 1000보다 작은 양수로 설정합니다. 값을 설정하지 않거나 매개변수를 0으로 설정하면 API는 기본값 50을 사용합니다. 매개변수를 음수 값으로 설정하면 API에서 INVALID_ARGUMENT 오류를 반환합니다.
리소스별 pageSize 값은 리소스 참조 문서(예: AdBreaks)를 참고하세요.
컬렉션의 마지막이 아닌 경우에도 API는 요청된 수보다 적은 결과 (결과 0 포함)를 반환할 수 있습니다. nextPageToken 필드의 존재 여부를 사용하여 컬렉션에 추가 결과가 있는지 확인합니다.
컬렉션의 응답 메시지는 다음 페이지를 검색하는 데 사용할 수 있는 문자열 nextPageToken 필드를 정의합니다. 컬렉션 끝에 도달하면 nextPageToken 필드가 비어 있습니다. 컬렉션의 끝에 도달했는지 확인하는 유일한 방법입니다.
컬렉션의 요청 메시지는 컬렉션의 다음 페이지로 이동하는 선택적 문자열 pageToken 필드를 정의합니다. 후속 페이지 요청에서 pageSize를 변경할 수 있습니다. 다른 모든 인수는 동일해야 합니다. 인수가 다른 경우 API는 INVALID_ARGUMENT 오류를 반환합니다.
예
cURL
최초 요청
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500
{
"adUnits": [ ... ],
"nextPageToken": "eCGwAcs6hUerggzd2DGv"
}
다음 페이지 요청
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv
{
"adUnits": [ ... ]
}
전체 크기
컬렉션의 응답 메시지는 필터링이 적용된 후의 총 항목 수를 나타내는 정수 totalSize를 제공합니다. 이 필드는 필드 마스크에서 요청된 경우에만 채워집니다.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
결과 정렬
컬렉션의 요청 메시지는 정렬 순서를 지정하는 문자열 orderBy 필드를 정의합니다.
값은 쉼표로 구분된 필드 목록이어야 합니다. 예: foo,bar 기본 정렬 순서는 오름차순입니다. 필드에서 내림차순으로 지정하려면 desc 접미사를 추가합니다(예: foo desc, bar). 구문에서 중복되는 공백 문자는 무시됩니다. orderBy 값 foo, bar desc, foo , bar desc, foo,bar desc은 모두 동일합니다. 하위 필드는 . 문자(예: foo.bar 또는 address.street)로 지정됩니다.
정렬은 기본 필드에서만 지원됩니다.
결과 건너뛰기
페이징된 작업의 메서드는 결과를 건너뛰는 정수 skip 필드를 정의합니다. 건너뛰기 값은 페이지 수가 아닌 건너뛸 개별 리소스의 수를 나타냅니다.
예를 들면 다음과 같습니다.
페이지 토큰이 없고 건너뛰기 값이 30인 요청은 31번째 결과부터 시작하는 단일 결과 페이지를 반환합니다.
51번째 결과에 해당하는 페이지 토큰 (첫 50개 결과가 첫 페이지에 반환되었기 때문에)과 건너뛰기 값 30이 있는 요청은 81번째 결과부터 시작하는 단일 페이지의 결과를 반환합니다.
커서가 결과 모음의 끝을 지나가도록 하는 건너뛰기 값이 제공되면 응답은 nextPageToken가 없는 빈 결과 집합이 포함된 200 OK입니다.