DCM/DFA Reporting And Trafficking API . 4 . advertiserLandingPages

Instance Methods

get(profileId=*, id=*)

Gets one landing page by ID.

insert(profileId=*, body=None)

Inserts a new landing page.

list(profileId=*, campaignIds=None, archived=None, pageToken=None, advertiserIds=None, sortOrder=None, maxResults=None, searchString=None, subaccountId=None, sortField=None, ids=None)

Retrieves a list of landing pages.

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

patch(profileId=*, id=*, body=None)

Updates an existing landing page. This method supports patch semantics.

update(profileId=*, body=None)

Updates an existing landing page.

Method Details

get(profileId=*, id=*)
Gets one landing page by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Landing page ID. (required)

Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "archived": True or False, # Whether this landing page has been archived.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
      "url": "A String", # URL of this landing page. This is a required field.
      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
        { # Contains information about a landing page deep link.
          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
            "directory": "A String", # Mobile app directory.
            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
            "publisherName": "A String", # Publisher name.
            "id": "A String", # ID of this mobile app.
            "title": "A String", # Title of this mobile app.
          },
          "appUrl": "A String", # The URL of the mobile app being linked to.
          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
            "A String",
          ],
        },
      ],
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    }
insert(profileId=*, body=None)
Inserts a new landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "archived": True or False, # Whether this landing page has been archived.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
    "url": "A String", # URL of this landing page. This is a required field.
    "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
      { # Contains information about a landing page deep link.
        "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
          "directory": "A String", # Mobile app directory.
          "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
          "publisherName": "A String", # Publisher name.
          "id": "A String", # ID of this mobile app.
          "title": "A String", # Title of this mobile app.
        },
        "appUrl": "A String", # The URL of the mobile app being linked to.
        "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
        "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
        "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
          "A String",
        ],
      },
    ],
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "archived": True or False, # Whether this landing page has been archived.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
      "url": "A String", # URL of this landing page. This is a required field.
      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
        { # Contains information about a landing page deep link.
          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
            "directory": "A String", # Mobile app directory.
            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
            "publisherName": "A String", # Publisher name.
            "id": "A String", # ID of this mobile app.
            "title": "A String", # Title of this mobile app.
          },
          "appUrl": "A String", # The URL of the mobile app being linked to.
          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
            "A String",
          ],
        },
      ],
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    }
list(profileId=*, campaignIds=None, archived=None, pageToken=None, advertiserIds=None, sortOrder=None, maxResults=None, searchString=None, subaccountId=None, sortField=None, ids=None)
Retrieves a list of landing pages.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignIds: string, Select only landing pages that are associated with these campaigns. (repeated)
  archived: boolean, Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
  pageToken: string, Value of the nextPageToken from the previous result page.
  advertiserIds: string, Select only landing pages that belong to these advertisers. (repeated)
  sortOrder: string, Order of sorted results.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  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".
  subaccountId: string, Select only landing pages that belong to this subaccount.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only landing pages with these IDs. (repeated)

Returns:
  An object of the form:

    { # Landing Page List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#advertiserLandingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse".
    "landingPages": [ # Landing page collection
      { # Contains information about where a user's browser is taken after the user clicks an ad.
          "archived": True or False, # Whether this landing page has been archived.
          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
          "url": "A String", # URL of this landing page. This is a required field.
          "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
            { # Contains information about a landing page deep link.
              "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
                "directory": "A String", # Mobile app directory.
                "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
                "publisherName": "A String", # Publisher name.
                "id": "A String", # ID of this mobile app.
                "title": "A String", # Title of this mobile app.
              },
              "appUrl": "A String", # The URL of the mobile app being linked to.
              "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
              "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
              "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
                "A String",
              ],
            },
          ],
          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
          "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
        },
    ],
  }
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
patch(profileId=*, id=*, body=None)
Updates an existing landing page. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Landing page ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "archived": True or False, # Whether this landing page has been archived.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
    "url": "A String", # URL of this landing page. This is a required field.
    "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
      { # Contains information about a landing page deep link.
        "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
          "directory": "A String", # Mobile app directory.
          "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
          "publisherName": "A String", # Publisher name.
          "id": "A String", # ID of this mobile app.
          "title": "A String", # Title of this mobile app.
        },
        "appUrl": "A String", # The URL of the mobile app being linked to.
        "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
        "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
        "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
          "A String",
        ],
      },
    ],
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "archived": True or False, # Whether this landing page has been archived.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
      "url": "A String", # URL of this landing page. This is a required field.
      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
        { # Contains information about a landing page deep link.
          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
            "directory": "A String", # Mobile app directory.
            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
            "publisherName": "A String", # Publisher name.
            "id": "A String", # ID of this mobile app.
            "title": "A String", # Title of this mobile app.
          },
          "appUrl": "A String", # The URL of the mobile app being linked to.
          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
            "A String",
          ],
        },
      ],
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    }
update(profileId=*, body=None)
Updates an existing landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "archived": True or False, # Whether this landing page has been archived.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
    "url": "A String", # URL of this landing page. This is a required field.
    "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
      { # Contains information about a landing page deep link.
        "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
          "directory": "A String", # Mobile app directory.
          "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
          "publisherName": "A String", # Publisher name.
          "id": "A String", # ID of this mobile app.
          "title": "A String", # Title of this mobile app.
        },
        "appUrl": "A String", # The URL of the mobile app being linked to.
        "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
        "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
        "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
          "A String",
        ],
      },
    ],
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "archived": True or False, # Whether this landing page has been archived.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
      "url": "A String", # URL of this landing page. This is a required field.
      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
        { # Contains information about a landing page deep link.
          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
            "directory": "A String", # Mobile app directory.
            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
            "publisherName": "A String", # Publisher name.
            "id": "A String", # ID of this mobile app.
            "title": "A String", # Title of this mobile app.
          },
          "appUrl": "A String", # The URL of the mobile app being linked to.
          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
            "A String",
          ],
        },
      ],
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    }