Method: advertiserLandingPages.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of landing pages.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/advertiserLandingPages
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
Query parameters
Parameters |
ids[] |
string (int64 format)
Select only landing pages with these IDs.
|
advertiserIds[] |
string (int64 format)
Select only landing pages that belong to these advertisers.
|
archived |
boolean
Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
|
subaccountId |
string (int64 format)
Select only landing pages that belong to this subaccount.
|
searchString |
string
Allows searching for landing pages by name or ID. Wildcards (
*
) are allowed. For example,
"landingpage*2017"
will return landing pages with names like
"landingpage July 2017"
,
"landingpage March 2017"
, or simply
"landingpage 2017"
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
"landingpage"
will match campaigns with name
"my landingpage"
,
"landingpage 2015"
, or simply
"landingpage"
.
|
campaignIds[] |
string (int64 format)
Select only landing pages that are associated with these campaigns.
|
maxResults |
integer
Maximum number of results to return.
|
pageToken |
string
Value of the
nextPageToken
from the previous result page.
|
sortField |
enum (SortField )
Field by which to sort the list.
|
sortOrder |
enum (SortOrder )
Order of sorted results.
|
Request body
The request body must be empty.
Response body
Landing Page advertiserLandingPages.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"nextPageToken": string,
"landingPages": [
{
object (LandingPage )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#advertiserLandingPagesListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
landingPages[] |
object (LandingPage )
Landing page collection
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of advertiser landing pages filtered by various criteria such as IDs, advertiser IDs, archived status, and search terms.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using an HTTP GET method to a specific endpoint with path and query parameters defining the scope of the retrieval.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of landing pages, pagination information for accessing subsequent result sets, and standard response metadata.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope for accessing and retrieving the landing page data.\u003c/p\u003e\n"]]],[],null,["# Method: advertiserLandingPages.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.AdvertiserLandingPagesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of landing pages.\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/advertiserLandingPages`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only landing pages with these IDs. |\n| `advertiser``Ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only landing pages that belong to these advertisers. |\n| `archived` | `boolean` Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. |\n| `subaccount``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only landing pages that belong to this subaccount. |\n| `search``String` | `string` Allows searching for landing pages by name or ID. Wildcards ( `*` ) are allowed. For example, `\"landingpage*2017\"` will return landing pages with names like `\"landingpage July 2017\"` , `\"landingpage March 2017\"` , or simply `\"landingpage 2017\"` . Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of `\"landingpage\"` will match campaigns with name `\"my landingpage\"` , `\"landingpage 2015\"` , or simply `\"landingpage\"` . |\n| `campaign``Ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only landing pages that are associated with these campaigns. |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nLanding Page advertiserLandingPages.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"landingPages\": [ { object (/doubleclick-advertisers/rest/v4/advertiserLandingPages#LandingPage) } ] } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#advertiserLandingPagesListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `landing``Pages[]` | `object (`[LandingPage](/doubleclick-advertisers/rest/v4/advertiserLandingPages#LandingPage)`)` Landing page collection |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]