1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="mybusinessplaceactions_v1.html">My Business Place Actions API</a> . <a href="mybusinessplaceactions_v1.locations.html">locations</a> . <a href="mybusinessplaceactions_v1.locations.placeActionLinks.html">placeActionLinks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a place action link associated with the specified location, and returns it. The request is considered duplicate if the `parent`, `place_action_link.uri` and `place_action_link.place_action_type` are the same as a previous request.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a place action link from the specified location.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the specified place action link.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the place action links for the specified location.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates the specified place action link and returns it.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <pre>Creates a place action link associated with the specified location, and returns it. The request is considered duplicate if the `parent`, `place_action_link.uri` and `place_action_link.place_action_type` are the same as a previous request. 107 108Args: 109 parent: string, Required. The resource name of the location where to create this place action link. `locations/{location_id}`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Represents a place action link and its attributes. 114 "createTime": "A String", # Output only. The time when the place action link was created. 115 "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. 116 "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. 117 "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. 118 "placeActionType": "A String", # Required. The type of place action that can be performed using this link. 119 "providerType": "A String", # Output only. Specifies the provider type. 120 "updateTime": "A String", # Output only. The time when the place action link was last modified. 121 "uri": "A String", # Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location). 122} 123 124 x__xgafv: string, V1 error format. 125 Allowed values 126 1 - v1 error format 127 2 - v2 error format 128 129Returns: 130 An object of the form: 131 132 { # Represents a place action link and its attributes. 133 "createTime": "A String", # Output only. The time when the place action link was created. 134 "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. 135 "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. 136 "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. 137 "placeActionType": "A String", # Required. The type of place action that can be performed using this link. 138 "providerType": "A String", # Output only. Specifies the provider type. 139 "updateTime": "A String", # Output only. The time when the place action link was last modified. 140 "uri": "A String", # Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location). 141}</pre> 142</div> 143 144<div class="method"> 145 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 146 <pre>Deletes a place action link from the specified location. 147 148Args: 149 name: string, Required. The resource name of the place action link to remove from the location. (required) 150 x__xgafv: string, V1 error format. 151 Allowed values 152 1 - v1 error format 153 2 - v2 error format 154 155Returns: 156 An object of the form: 157 158 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 159}</pre> 160</div> 161 162<div class="method"> 163 <code class="details" id="get">get(name, x__xgafv=None)</code> 164 <pre>Gets the specified place action link. 165 166Args: 167 name: string, Required. The name of the place action link to fetch. (required) 168 x__xgafv: string, V1 error format. 169 Allowed values 170 1 - v1 error format 171 2 - v2 error format 172 173Returns: 174 An object of the form: 175 176 { # Represents a place action link and its attributes. 177 "createTime": "A String", # Output only. The time when the place action link was created. 178 "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. 179 "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. 180 "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. 181 "placeActionType": "A String", # Required. The type of place action that can be performed using this link. 182 "providerType": "A String", # Output only. Specifies the provider type. 183 "updateTime": "A String", # Output only. The time when the place action link was last modified. 184 "uri": "A String", # Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location). 185}</pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 190 <pre>Lists the place action links for the specified location. 191 192Args: 193 parent: string, Required. The name of the location whose place action links will be listed. `locations/{location_id}`. (required) 194 filter: string, Optional. A filter constraining the place action links to return. The response includes entries that match the filter. We support only the following filter: 1. place_action_type=XYZ where XYZ is a valid PlaceActionType. 195 pageSize: integer, Optional. How many place action links to return per page. Default of 10. The minimum is 1. 196 pageToken: string, Optional. If specified, returns the next page of place action links. 197 x__xgafv: string, V1 error format. 198 Allowed values 199 1 - v1 error format 200 2 - v2 error format 201 202Returns: 203 An object of the form: 204 205 { # Response message for PlaceActions.ListPlaceActionLinks. 206 "nextPageToken": "A String", # If there are more place action links than the requested page size, then this field is populated with a token to fetch the next page of results. 207 "placeActionLinks": [ # The returned list of place action links. 208 { # Represents a place action link and its attributes. 209 "createTime": "A String", # Output only. The time when the place action link was created. 210 "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. 211 "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. 212 "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. 213 "placeActionType": "A String", # Required. The type of place action that can be performed using this link. 214 "providerType": "A String", # Output only. Specifies the provider type. 215 "updateTime": "A String", # Output only. The time when the place action link was last modified. 216 "uri": "A String", # Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location). 217 }, 218 ], 219}</pre> 220</div> 221 222<div class="method"> 223 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 224 <pre>Retrieves the next page of results. 225 226Args: 227 previous_request: The request for the previous page. (required) 228 previous_response: The response from the request for the previous page. (required) 229 230Returns: 231 A request object that you can call 'execute()' on to request the next 232 page. Returns None if there are no more items in the collection. 233 </pre> 234</div> 235 236<div class="method"> 237 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 238 <pre>Updates the specified place action link and returns it. 239 240Args: 241 name: string, Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. (required) 242 body: object, The request body. 243 The object takes the form of: 244 245{ # Represents a place action link and its attributes. 246 "createTime": "A String", # Output only. The time when the place action link was created. 247 "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. 248 "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. 249 "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. 250 "placeActionType": "A String", # Required. The type of place action that can be performed using this link. 251 "providerType": "A String", # Output only. Specifies the provider type. 252 "updateTime": "A String", # Output only. The time when the place action link was last modified. 253 "uri": "A String", # Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location). 254} 255 256 updateMask: string, Required. The specific fields to update. The only editable fields are `uri`, `place_action_type` and `is_preferred`. If the updated link already exists at the same location with the same `place_action_type` and `uri`, fails with an `ALREADY_EXISTS` error. 257 x__xgafv: string, V1 error format. 258 Allowed values 259 1 - v1 error format 260 2 - v2 error format 261 262Returns: 263 An object of the form: 264 265 { # Represents a place action link and its attributes. 266 "createTime": "A String", # Output only. The time when the place action link was created. 267 "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. 268 "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. 269 "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. 270 "placeActionType": "A String", # Required. The type of place action that can be performed using this link. 271 "providerType": "A String", # Output only. Specifies the provider type. 272 "updateTime": "A String", # Output only. The time when the place action link was last modified. 273 "uri": "A String", # Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location). 274}</pre> 275</div> 276 277</body></html>