Ad Manager REST API는 데이터 모음을 제공하며, 주로 목록으로 메서드를 참조하세요. API에서 컬렉션의 크기를 임의로 조정하고 페이지로 나눔 확인할 수 있습니다
기본사항
컬렉션 요청 메시지는 다음과 같은 선택적 정수 pageSize 필드를 정의합니다.
반환할 결과의 최대 수를 지정합니다.
pageSize를 설정하지 않거나 0으로 설정하면 기본값 50이 사용됩니다.
pageSize가 최대 페이지 크기인 1, 000을 초과하면 API는
1,000페이지로 줄일 수 있습니다.
값이 음수이면 INVALID_ARGUMENT 오류가 발생합니다.
API가 요청된 수보다 적은 수의 결과를 반환할 수 있습니다 (0과
결과)이 포함될 수 있습니다. 이때
nextPageToken 필드를 사용하여
컬렉션입니다.
컬렉션의 응답 메시지는 문자열 nextPageToken 필드를 정의합니다. 이 필드는
다음 페이지를 가져오는 데 사용할 수 있습니다.
컬렉션의 끝이 다음과 같으면 nextPageToken 필드는 비어 있습니다.
도달할 수 있습니다 이 방법이 마지막에 도달했는지 확인할 수 있는 유일한 방법입니다.
컬렉션입니다.
컬렉션 요청 메시지는 선택적 문자열 pageToken 필드를 정의합니다.
컬렉션의 다음 페이지로 이동할 수 있습니다.
이후 페이지를 요청할 때 pageSize를 변경할 수 있습니다.
다른 모든 인수는 동일해야 합니다. 인수가 다르면
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번째 결과부터 시작하는 결과의 단일 페이지
커서가
결과 컬렉션의 경우 응답은 200 OK이고
nextPageToken입니다.